From 6a7c40fbe9e900fdb0130a87b9769cdb556ebfad Mon Sep 17 00:00:00 2001 From: Jen Young Date: Mon, 3 Feb 2025 09:06:41 -0800 Subject: [PATCH 1/3] Update descriptions --- openapi-sdk.yaml | 84 +- openapi.yaml | 84 +- sdks/dotnet/docs/FaxApi.md | 14 +- sdks/dotnet/docs/FaxLineAddUserRequest.md | 2 +- sdks/dotnet/docs/FaxLineApi.md | 22 +- sdks/dotnet/docs/FaxLineCreateRequest.md | 2 +- sdks/dotnet/docs/FaxLineDeleteRequest.md | 2 +- sdks/dotnet/docs/FaxLineRemoveUserRequest.md | 2 +- sdks/dotnet/docs/FaxSendRequest.md | 2 +- sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs | 112 +- .../dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs | 176 +- .../Model/FaxLineAddUserRequest.cs | 6 +- .../Model/FaxLineCreateRequest.cs | 28 +- .../Model/FaxLineDeleteRequest.cs | 6 +- .../Model/FaxLineRemoveUserRequest.cs | 18 +- .../src/Dropbox.Sign/Model/FaxSendRequest.cs | 30 +- sdks/java-v1/docs/FaxApi.md | 14 +- sdks/java-v1/docs/FaxLineAddUserRequest.md | 2 +- sdks/java-v1/docs/FaxLineApi.md | 22 +- sdks/java-v1/docs/FaxLineCreateRequest.md | 8 +- sdks/java-v1/docs/FaxLineDeleteRequest.md | 2 +- sdks/java-v1/docs/FaxLineRemoveUserRequest.md | 6 +- sdks/java-v1/docs/FaxSendRequest.md | 10 +- .../java/com/dropbox/sign/api/FaxApi.java | 32 +- .../java/com/dropbox/sign/api/FaxLineApi.java | 52 +- .../sign/model/FaxLineAddUserRequest.java | 2 +- .../sign/model/FaxLineCreateRequest.java | 10 +- .../sign/model/FaxLineDeleteRequest.java | 2 +- .../sign/model/FaxLineRemoveUserRequest.java | 6 +- .../dropbox/sign/model/FaxSendRequest.java | 12 +- sdks/java-v2/docs/FaxApi.md | 14 +- sdks/java-v2/docs/FaxLineAddUserRequest.md | 2 +- sdks/java-v2/docs/FaxLineApi.md | 22 +- sdks/java-v2/docs/FaxLineCreateRequest.md | 8 +- sdks/java-v2/docs/FaxLineDeleteRequest.md | 2 +- sdks/java-v2/docs/FaxLineRemoveUserRequest.md | 6 +- sdks/java-v2/docs/FaxSendRequest.md | 10 +- .../java/com/dropbox/sign/api/FaxApi.java | 28 +- .../java/com/dropbox/sign/api/FaxLineApi.java | 44 +- .../sign/model/FaxLineAddUserRequest.java | 2 +- .../sign/model/FaxLineCreateRequest.java | 10 +- .../sign/model/FaxLineDeleteRequest.java | 2 +- .../sign/model/FaxLineRemoveUserRequest.java | 6 +- .../dropbox/sign/model/FaxSendRequest.java | 10 +- sdks/node/api/faxApi.ts | 14 +- sdks/node/api/faxLineApi.ts | 22 +- sdks/node/docs/api/FaxApi.md | 14 +- sdks/node/docs/api/FaxLineApi.md | 22 +- sdks/node/docs/model/FaxLineAddUserRequest.md | 2 +- sdks/node/docs/model/FaxLineCreateRequest.md | 8 +- sdks/node/docs/model/FaxLineDeleteRequest.md | 2 +- .../docs/model/FaxLineRemoveUserRequest.md | 6 +- sdks/node/docs/model/FaxSendRequest.md | 10 +- sdks/node/model/faxLineAddUserRequest.ts | 2 +- sdks/node/model/faxLineCreateRequest.ts | 8 +- sdks/node/model/faxLineDeleteRequest.ts | 2 +- sdks/node/model/faxLineRemoveUserRequest.ts | 6 +- sdks/node/model/faxSendRequest.ts | 10 +- sdks/php/README.md | 27 +- sdks/php/docs/Api/AccountApi.md | 109 +- sdks/php/docs/Api/ApiAppApi.md | 164 +- sdks/php/docs/Api/BulkSendJobApi.md | 61 +- sdks/php/docs/Api/EmbeddedApi.md | 56 +- sdks/php/docs/Api/FaxApi.md | 135 +- sdks/php/docs/Api/FaxLineApi.md | 183 +- sdks/php/docs/Api/OAuthApi.md | 45 +- sdks/php/docs/Api/ReportApi.md | 29 +- sdks/php/docs/Api/SignatureRequestApi.md | 618 +----- sdks/php/docs/Api/TeamApi.md | 266 +-- sdks/php/docs/Api/TemplateApi.md | 363 +--- sdks/php/docs/Api/UnclaimedDraftApi.md | 163 +- sdks/php/docs/Model/AccountCreateRequest.md | 12 +- sdks/php/docs/Model/AccountCreateResponse.md | 6 +- sdks/php/docs/Model/AccountGetResponse.md | 4 +- sdks/php/docs/Model/AccountResponse.md | 22 +- sdks/php/docs/Model/AccountResponseQuotas.md | 12 +- sdks/php/docs/Model/AccountResponseUsage.md | 2 +- sdks/php/docs/Model/AccountUpdateRequest.md | 6 +- sdks/php/docs/Model/AccountVerifyRequest.md | 2 +- sdks/php/docs/Model/AccountVerifyResponse.md | 4 +- .../Model/AccountVerifyResponseAccount.md | 2 +- sdks/php/docs/Model/ApiAppCreateRequest.md | 14 +- sdks/php/docs/Model/ApiAppGetResponse.md | 4 +- sdks/php/docs/Model/ApiAppListResponse.md | 6 +- sdks/php/docs/Model/ApiAppResponse.md | 20 +- sdks/php/docs/Model/ApiAppResponseOAuth.md | 8 +- sdks/php/docs/Model/ApiAppResponseOptions.md | 2 +- .../docs/Model/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- sdks/php/docs/Model/ApiAppUpdateRequest.md | 14 +- sdks/php/docs/Model/BulkSendJobGetResponse.md | 8 +- ...BulkSendJobGetResponseSignatureRequests.md | 53 +- .../php/docs/Model/BulkSendJobListResponse.md | 6 +- sdks/php/docs/Model/BulkSendJobResponse.md | 8 +- .../php/docs/Model/BulkSendJobSendResponse.md | 4 +- sdks/php/docs/Model/EmbeddedEditUrlRequest.md | 24 +- .../php/docs/Model/EmbeddedEditUrlResponse.md | 4 +- .../Model/EmbeddedEditUrlResponseEmbedded.md | 4 +- .../php/docs/Model/EmbeddedSignUrlResponse.md | 4 +- .../Model/EmbeddedSignUrlResponseEmbedded.md | 4 +- sdks/php/docs/Model/ErrorResponse.md | 2 +- sdks/php/docs/Model/ErrorResponseError.md | 6 +- sdks/php/docs/Model/EventCallbackRequest.md | 8 +- .../docs/Model/EventCallbackRequestEvent.md | 8 +- .../EventCallbackRequestEventMetadata.md | 8 +- sdks/php/docs/Model/FaxGetResponse.md | 4 +- sdks/php/docs/Model/FaxLineAddUserRequest.md | 6 +- .../docs/Model/FaxLineAreaCodeGetResponse.md | 2 +- sdks/php/docs/Model/FaxLineCreateRequest.md | 8 +- sdks/php/docs/Model/FaxLineDeleteRequest.md | 2 +- sdks/php/docs/Model/FaxLineListResponse.md | 6 +- .../docs/Model/FaxLineRemoveUserRequest.md | 6 +- sdks/php/docs/Model/FaxLineResponse.md | 4 +- sdks/php/docs/Model/FaxLineResponseFaxLine.md | 8 +- sdks/php/docs/Model/FaxListResponse.md | 4 +- sdks/php/docs/Model/FaxResponse.md | 22 +- .../php/docs/Model/FaxResponseTransmission.md | 6 +- sdks/php/docs/Model/FaxSendRequest.md | 23 +- sdks/php/docs/Model/FileResponse.md | 4 +- sdks/php/docs/Model/FileResponseDataUri.md | 2 +- sdks/php/docs/Model/ListInfoResponse.md | 8 +- .../docs/Model/OAuthTokenGenerateRequest.md | 10 +- .../docs/Model/OAuthTokenRefreshRequest.md | 8 +- sdks/php/docs/Model/OAuthTokenResponse.md | 10 +- sdks/php/docs/Model/ReportCreateRequest.md | 6 +- sdks/php/docs/Model/ReportCreateResponse.md | 4 +- sdks/php/docs/Model/ReportResponse.md | 8 +- ...stBulkCreateEmbeddedWithTemplateRequest.md | 52 +- ...atureRequestBulkSendWithTemplateRequest.md | 52 +- .../SignatureRequestCreateEmbeddedRequest.md | 81 +- ...equestCreateEmbeddedWithTemplateRequest.md | 38 +- .../docs/Model/SignatureRequestGetResponse.md | 4 +- .../Model/SignatureRequestListResponse.md | 6 +- .../Model/SignatureRequestRemindRequest.md | 4 +- .../docs/Model/SignatureRequestResponse.md | 53 +- .../SignatureRequestResponseAttachment.md | 12 +- ...SignatureRequestResponseCustomFieldBase.md | 14 +- ...atureRequestResponseCustomFieldCheckbox.md | 6 +- ...SignatureRequestResponseCustomFieldText.md | 6 +- .../Model/SignatureRequestResponseDataBase.md | 10 +- ...gnatureRequestResponseDataValueCheckbox.md | 4 +- ...reRequestResponseDataValueCheckboxMerge.md | 4 +- ...atureRequestResponseDataValueDateSigned.md | 4 +- ...gnatureRequestResponseDataValueDropdown.md | 4 +- ...gnatureRequestResponseDataValueInitials.md | 6 +- .../SignatureRequestResponseDataValueRadio.md | 4 +- ...natureRequestResponseDataValueSignature.md | 6 +- .../SignatureRequestResponseDataValueText.md | 4 +- ...natureRequestResponseDataValueTextMerge.md | 4 +- .../SignatureRequestResponseSignatures.md | 38 +- .../docs/Model/SignatureRequestSendRequest.md | 90 +- ...SignatureRequestSendWithTemplateRequest.md | 47 +- .../Model/SignatureRequestUpdateRequest.md | 14 +- sdks/php/docs/Model/SubAttachment.md | 10 +- sdks/php/docs/Model/SubBulkSignerList.md | 6 +- .../Model/SubBulkSignerListCustomField.md | 4 +- sdks/php/docs/Model/SubCC.md | 4 +- sdks/php/docs/Model/SubCustomField.md | 16 +- sdks/php/docs/Model/SubEditorOptions.md | 4 +- sdks/php/docs/Model/SubFieldOptions.md | 4 +- sdks/php/docs/Model/SubFormFieldGroup.md | 10 +- sdks/php/docs/Model/SubFormFieldRule.md | 8 +- sdks/php/docs/Model/SubFormFieldRuleAction.md | 16 +- .../php/docs/Model/SubFormFieldRuleTrigger.md | 41 +- .../Model/SubFormFieldsPerDocumentBase.md | 49 +- .../Model/SubFormFieldsPerDocumentCheckbox.md | 8 +- .../SubFormFieldsPerDocumentCheckboxMerge.md | 4 +- .../SubFormFieldsPerDocumentDateSigned.md | 10 +- .../Model/SubFormFieldsPerDocumentDropdown.md | 14 +- .../SubFormFieldsPerDocumentHyperlink.md | 14 +- .../Model/SubFormFieldsPerDocumentInitials.md | 4 +- .../Model/SubFormFieldsPerDocumentRadio.md | 8 +- .../SubFormFieldsPerDocumentSignature.md | 4 +- .../Model/SubFormFieldsPerDocumentText.md | 28 +- .../SubFormFieldsPerDocumentTextMerge.md | 10 +- sdks/php/docs/Model/SubMergeField.md | 4 +- sdks/php/docs/Model/SubOAuth.md | 4 +- sdks/php/docs/Model/SubOptions.md | 2 +- .../SubSignatureRequestGroupedSigners.md | 8 +- .../docs/Model/SubSignatureRequestSigner.md | 20 +- .../SubSignatureRequestTemplateSigner.md | 20 +- sdks/php/docs/Model/SubSigningOptions.md | 12 +- sdks/php/docs/Model/SubTeamResponse.md | 4 +- sdks/php/docs/Model/SubTemplateRole.md | 4 +- .../php/docs/Model/SubUnclaimedDraftSigner.md | 6 +- .../Model/SubUnclaimedDraftTemplateSigner.md | 6 +- .../php/docs/Model/SubWhiteLabelingOptions.md | 30 +- sdks/php/docs/Model/TeamAddMemberRequest.md | 12 +- sdks/php/docs/Model/TeamCreateRequest.md | 2 +- sdks/php/docs/Model/TeamGetInfoResponse.md | 4 +- sdks/php/docs/Model/TeamGetResponse.md | 4 +- sdks/php/docs/Model/TeamInfoResponse.md | 10 +- sdks/php/docs/Model/TeamInviteResponse.md | 12 +- sdks/php/docs/Model/TeamInvitesResponse.md | 4 +- sdks/php/docs/Model/TeamMemberResponse.md | 6 +- sdks/php/docs/Model/TeamMembersResponse.md | 6 +- sdks/php/docs/Model/TeamParentResponse.md | 6 +- .../php/docs/Model/TeamRemoveMemberRequest.md | 18 +- sdks/php/docs/Model/TeamResponse.md | 8 +- sdks/php/docs/Model/TeamSubTeamsResponse.md | 6 +- sdks/php/docs/Model/TeamUpdateRequest.md | 2 +- sdks/php/docs/Model/TemplateAddUserRequest.md | 8 +- .../TemplateCreateEmbeddedDraftRequest.md | 75 +- .../TemplateCreateEmbeddedDraftResponse.md | 4 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 10 +- sdks/php/docs/Model/TemplateCreateRequest.md | 58 +- sdks/php/docs/Model/TemplateCreateResponse.md | 4 +- .../Model/TemplateCreateResponseTemplate.md | 4 +- sdks/php/docs/Model/TemplateEditResponse.md | 2 +- sdks/php/docs/Model/TemplateGetResponse.md | 4 +- sdks/php/docs/Model/TemplateListResponse.md | 6 +- .../docs/Model/TemplateRemoveUserRequest.md | 4 +- sdks/php/docs/Model/TemplateResponse.md | 34 +- .../php/docs/Model/TemplateResponseAccount.md | 12 +- .../Model/TemplateResponseAccountQuota.md | 8 +- sdks/php/docs/Model/TemplateResponseCCRole.md | 2 +- .../docs/Model/TemplateResponseDocument.md | 12 +- ...TemplateResponseDocumentCustomFieldBase.md | 20 +- ...lateResponseDocumentCustomFieldCheckbox.md | 7 +- ...TemplateResponseDocumentCustomFieldText.md | 15 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 8 +- .../TemplateResponseDocumentFormFieldBase.md | 18 +- ...mplateResponseDocumentFormFieldCheckbox.md | 15 +- ...lateResponseDocumentFormFieldDateSigned.md | 15 +- ...mplateResponseDocumentFormFieldDropdown.md | 15 +- ...plateResponseDocumentFormFieldHyperlink.md | 23 +- ...mplateResponseDocumentFormFieldInitials.md | 15 +- .../TemplateResponseDocumentFormFieldRadio.md | 15 +- ...plateResponseDocumentFormFieldSignature.md | 15 +- .../TemplateResponseDocumentFormFieldText.md | 25 +- ...TemplateResponseDocumentStaticFieldBase.md | 20 +- ...lateResponseDocumentStaticFieldCheckbox.md | 13 +- ...teResponseDocumentStaticFieldDateSigned.md | 13 +- ...lateResponseDocumentStaticFieldDropdown.md | 13 +- ...ateResponseDocumentStaticFieldHyperlink.md | 13 +- ...lateResponseDocumentStaticFieldInitials.md | 13 +- ...emplateResponseDocumentStaticFieldRadio.md | 13 +- ...ateResponseDocumentStaticFieldSignature.md | 13 +- ...TemplateResponseDocumentStaticFieldText.md | 13 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/Model/TemplateResponseSignerRole.md | 4 +- .../docs/Model/TemplateUpdateFilesRequest.md | 16 +- .../docs/Model/TemplateUpdateFilesResponse.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 4 +- .../UnclaimedDraftCreateEmbeddedRequest.md | 104 +- ...dDraftCreateEmbeddedWithTemplateRequest.md | 78 +- .../docs/Model/UnclaimedDraftCreateRequest.md | 73 +- .../Model/UnclaimedDraftCreateResponse.md | 4 +- .../UnclaimedDraftEditAndResendRequest.md | 16 +- sdks/php/docs/Model/UnclaimedDraftResponse.md | 12 +- sdks/php/docs/Model/WarningResponse.md | 4 +- sdks/php/src/Api/AccountApi.php | 502 +++-- sdks/php/src/Api/ApiAppApi.php | 593 +++--- sdks/php/src/Api/BulkSendJobApi.php | 309 +-- sdks/php/src/Api/EmbeddedApi.php | 293 +-- sdks/php/src/Api/FaxApi.php | 585 +++--- sdks/php/src/Api/FaxLineApi.php | 845 ++++---- sdks/php/src/Api/OAuthApi.php | 342 ++-- sdks/php/src/Api/ReportApi.php | 173 +- sdks/php/src/Api/SignatureRequestApi.php | 1795 +++++++++-------- sdks/php/src/Api/TeamApi.php | 1116 +++++----- sdks/php/src/Api/TemplateApi.php | 1305 ++++++------ sdks/php/src/Api/UnclaimedDraftApi.php | 507 ++--- sdks/php/src/ApiException.php | 27 +- sdks/php/src/Configuration.php | 104 +- sdks/php/src/EventCallbackHelper.php | 8 +- sdks/php/src/HeaderSelector.php | 65 +- sdks/php/src/Model/AccountCreateRequest.php | 165 +- sdks/php/src/Model/AccountCreateResponse.php | 171 +- sdks/php/src/Model/AccountGetResponse.php | 163 +- sdks/php/src/Model/AccountResponse.php | 217 +- sdks/php/src/Model/AccountResponseQuotas.php | 184 +- sdks/php/src/Model/AccountResponseUsage.php | 154 +- sdks/php/src/Model/AccountUpdateRequest.php | 165 +- sdks/php/src/Model/AccountVerifyRequest.php | 153 +- sdks/php/src/Model/AccountVerifyResponse.php | 167 +- .../Model/AccountVerifyResponseAccount.php | 157 +- sdks/php/src/Model/ApiAppCreateRequest.php | 210 +- sdks/php/src/Model/ApiAppGetResponse.php | 163 +- sdks/php/src/Model/ApiAppListResponse.php | 171 +- sdks/php/src/Model/ApiAppResponse.php | 207 +- sdks/php/src/Model/ApiAppResponseOAuth.php | 175 +- sdks/php/src/Model/ApiAppResponseOptions.php | 155 +- .../src/Model/ApiAppResponseOwnerAccount.php | 159 +- .../ApiAppResponseWhiteLabelingOptions.php | 207 +- sdks/php/src/Model/ApiAppUpdateRequest.php | 202 +- sdks/php/src/Model/BulkSendJobGetResponse.php | 179 +- ...ulkSendJobGetResponseSignatureRequests.php | 299 +-- .../php/src/Model/BulkSendJobListResponse.php | 171 +- sdks/php/src/Model/BulkSendJobResponse.php | 175 +- .../php/src/Model/BulkSendJobSendResponse.php | 163 +- sdks/php/src/Model/EmbeddedEditUrlRequest.php | 209 +- .../php/src/Model/EmbeddedEditUrlResponse.php | 163 +- .../Model/EmbeddedEditUrlResponseEmbedded.php | 163 +- .../php/src/Model/EmbeddedSignUrlResponse.php | 163 +- .../Model/EmbeddedSignUrlResponseEmbedded.php | 163 +- sdks/php/src/Model/ErrorResponse.php | 155 +- sdks/php/src/Model/ErrorResponseError.php | 165 +- sdks/php/src/Model/EventCallbackRequest.php | 179 +- .../src/Model/EventCallbackRequestEvent.php | 174 +- .../EventCallbackRequestEventMetadata.php | 172 +- sdks/php/src/Model/FaxGetResponse.php | 163 +- sdks/php/src/Model/FaxLineAddUserRequest.php | 161 +- .../Model/FaxLineAreaCodeGetCountryEnum.php | 13 +- .../Model/FaxLineAreaCodeGetProvinceEnum.php | 13 +- .../src/Model/FaxLineAreaCodeGetResponse.php | 151 +- .../src/Model/FaxLineAreaCodeGetStateEnum.php | 13 +- sdks/php/src/Model/FaxLineCreateRequest.php | 172 +- sdks/php/src/Model/FaxLineDeleteRequest.php | 153 +- sdks/php/src/Model/FaxLineListResponse.php | 171 +- .../src/Model/FaxLineRemoveUserRequest.php | 165 +- sdks/php/src/Model/FaxLineResponse.php | 163 +- sdks/php/src/Model/FaxLineResponseFaxLine.php | 171 +- sdks/php/src/Model/FaxListResponse.php | 163 +- sdks/php/src/Model/FaxResponse.php | 195 +- .../php/src/Model/FaxResponseTransmission.php | 160 +- sdks/php/src/Model/FaxSendRequest.php | 196 +- sdks/php/src/Model/FileResponse.php | 159 +- sdks/php/src/Model/FileResponseDataUri.php | 153 +- sdks/php/src/Model/ListInfoResponse.php | 175 +- sdks/php/src/Model/ModelInterface.php | 13 +- .../src/Model/OAuthTokenGenerateRequest.php | 177 +- .../src/Model/OAuthTokenRefreshRequest.php | 167 +- sdks/php/src/Model/OAuthTokenResponse.php | 171 +- sdks/php/src/Model/ReportCreateRequest.php | 176 +- sdks/php/src/Model/ReportCreateResponse.php | 163 +- sdks/php/src/Model/ReportResponse.php | 172 +- ...tBulkCreateEmbeddedWithTemplateRequest.php | 239 ++- ...tureRequestBulkSendWithTemplateRequest.php | 239 ++- .../SignatureRequestCreateEmbeddedRequest.php | 305 +-- ...questCreateEmbeddedWithTemplateRequest.php | 249 +-- .../src/Model/SignatureRequestGetResponse.php | 163 +- .../Model/SignatureRequestListResponse.php | 171 +- .../Model/SignatureRequestRemindRequest.php | 157 +- .../src/Model/SignatureRequestResponse.php | 299 +-- .../SignatureRequestResponseAttachment.php | 183 +- ...ignatureRequestResponseCustomFieldBase.php | 163 +- ...tureRequestResponseCustomFieldCheckbox.php | 152 +- ...ignatureRequestResponseCustomFieldText.php | 152 +- ...tureRequestResponseCustomFieldTypeEnum.php | 13 +- .../SignatureRequestResponseDataBase.php | 167 +- .../SignatureRequestResponseDataTypeEnum.php | 13 +- ...natureRequestResponseDataValueCheckbox.php | 158 +- ...eRequestResponseDataValueCheckboxMerge.php | 158 +- ...tureRequestResponseDataValueDateSigned.php | 158 +- ...natureRequestResponseDataValueDropdown.php | 158 +- ...natureRequestResponseDataValueInitials.php | 164 +- ...SignatureRequestResponseDataValueRadio.php | 158 +- ...atureRequestResponseDataValueSignature.php | 164 +- .../SignatureRequestResponseDataValueText.php | 158 +- ...atureRequestResponseDataValueTextMerge.php | 158 +- .../SignatureRequestResponseSignatures.php | 261 +-- .../src/Model/SignatureRequestSendRequest.php | 315 +-- ...ignatureRequestSendWithTemplateRequest.php | 261 +-- .../Model/SignatureRequestUpdateRequest.php | 165 +- sdks/php/src/Model/SubAttachment.php | 169 +- sdks/php/src/Model/SubBulkSignerList.php | 167 +- .../Model/SubBulkSignerListCustomField.php | 157 +- sdks/php/src/Model/SubCC.php | 157 +- sdks/php/src/Model/SubCustomField.php | 165 +- sdks/php/src/Model/SubEditorOptions.php | 159 +- sdks/php/src/Model/SubFieldOptions.php | 154 +- sdks/php/src/Model/SubFormFieldGroup.php | 159 +- sdks/php/src/Model/SubFormFieldRule.php | 192 +- sdks/php/src/Model/SubFormFieldRuleAction.php | 166 +- .../php/src/Model/SubFormFieldRuleTrigger.php | 164 +- .../Model/SubFormFieldsPerDocumentBase.php | 195 +- .../SubFormFieldsPerDocumentCheckbox.php | 160 +- .../SubFormFieldsPerDocumentCheckboxMerge.php | 148 +- .../SubFormFieldsPerDocumentDateSigned.php | 159 +- .../SubFormFieldsPerDocumentDropdown.php | 176 +- .../SubFormFieldsPerDocumentFontEnum.php | 13 +- .../SubFormFieldsPerDocumentHyperlink.php | 171 +- .../SubFormFieldsPerDocumentInitials.php | 148 +- .../Model/SubFormFieldsPerDocumentRadio.php | 158 +- .../SubFormFieldsPerDocumentSignature.php | 148 +- .../Model/SubFormFieldsPerDocumentText.php | 195 +- .../SubFormFieldsPerDocumentTextMerge.php | 159 +- .../SubFormFieldsPerDocumentTypeEnum.php | 13 +- sdks/php/src/Model/SubMergeField.php | 158 +- sdks/php/src/Model/SubOAuth.php | 160 +- sdks/php/src/Model/SubOptions.php | 157 +- .../SubSignatureRequestGroupedSigners.php | 165 +- .../src/Model/SubSignatureRequestSigner.php | 188 +- .../SubSignatureRequestTemplateSigner.php | 186 +- sdks/php/src/Model/SubSigningOptions.php | 168 +- sdks/php/src/Model/SubTeamResponse.php | 159 +- sdks/php/src/Model/SubTemplateRole.php | 163 +- .../php/src/Model/SubUnclaimedDraftSigner.php | 165 +- .../Model/SubUnclaimedDraftTemplateSigner.php | 165 +- .../php/src/Model/SubWhiteLabelingOptions.php | 208 +- sdks/php/src/Model/TeamAddMemberRequest.php | 160 +- sdks/php/src/Model/TeamCreateRequest.php | 157 +- sdks/php/src/Model/TeamGetInfoResponse.php | 163 +- sdks/php/src/Model/TeamGetResponse.php | 163 +- sdks/php/src/Model/TeamInfoResponse.php | 175 +- sdks/php/src/Model/TeamInviteResponse.php | 187 +- sdks/php/src/Model/TeamInvitesResponse.php | 163 +- sdks/php/src/Model/TeamMemberResponse.php | 169 +- sdks/php/src/Model/TeamMembersResponse.php | 171 +- sdks/php/src/Model/TeamParentResponse.php | 159 +- .../php/src/Model/TeamRemoveMemberRequest.php | 170 +- sdks/php/src/Model/TeamResponse.php | 177 +- sdks/php/src/Model/TeamSubTeamsResponse.php | 171 +- sdks/php/src/Model/TeamUpdateRequest.php | 157 +- sdks/php/src/Model/TemplateAddUserRequest.php | 163 +- .../TemplateCreateEmbeddedDraftRequest.php | 309 +-- .../TemplateCreateEmbeddedDraftResponse.php | 163 +- ...ateCreateEmbeddedDraftResponseTemplate.php | 177 +- sdks/php/src/Model/TemplateCreateRequest.php | 269 +-- sdks/php/src/Model/TemplateCreateResponse.php | 163 +- .../Model/TemplateCreateResponseTemplate.php | 157 +- sdks/php/src/Model/TemplateEditResponse.php | 153 +- sdks/php/src/Model/TemplateGetResponse.php | 163 +- sdks/php/src/Model/TemplateListResponse.php | 171 +- .../src/Model/TemplateRemoveUserRequest.php | 159 +- sdks/php/src/Model/TemplateResponse.php | 253 +-- .../php/src/Model/TemplateResponseAccount.php | 189 +- .../Model/TemplateResponseAccountQuota.php | 175 +- sdks/php/src/Model/TemplateResponseCCRole.php | 157 +- .../src/Model/TemplateResponseDocument.php | 195 +- ...emplateResponseDocumentCustomFieldBase.php | 189 +- ...ateResponseDocumentCustomFieldCheckbox.php | 148 +- ...emplateResponseDocumentCustomFieldText.php | 174 +- .../TemplateResponseDocumentFieldGroup.php | 165 +- ...TemplateResponseDocumentFieldGroupRule.php | 159 +- .../TemplateResponseDocumentFormFieldBase.php | 187 +- ...plateResponseDocumentFormFieldCheckbox.php | 152 +- ...ateResponseDocumentFormFieldDateSigned.php | 152 +- ...plateResponseDocumentFormFieldDropdown.php | 152 +- ...lateResponseDocumentFormFieldHyperlink.php | 178 +- ...plateResponseDocumentFormFieldInitials.php | 152 +- ...TemplateResponseDocumentFormFieldRadio.php | 152 +- ...lateResponseDocumentFormFieldSignature.php | 152 +- .../TemplateResponseDocumentFormFieldText.php | 183 +- ...emplateResponseDocumentStaticFieldBase.php | 191 +- ...ateResponseDocumentStaticFieldCheckbox.php | 148 +- ...eResponseDocumentStaticFieldDateSigned.php | 148 +- ...ateResponseDocumentStaticFieldDropdown.php | 148 +- ...teResponseDocumentStaticFieldHyperlink.php | 148 +- ...ateResponseDocumentStaticFieldInitials.php | 148 +- ...mplateResponseDocumentStaticFieldRadio.php | 148 +- ...teResponseDocumentStaticFieldSignature.php | 148 +- ...emplateResponseDocumentStaticFieldText.php | 148 +- .../TemplateResponseFieldAvgTextLength.php | 163 +- .../src/Model/TemplateResponseSignerRole.php | 163 +- .../src/Model/TemplateUpdateFilesRequest.php | 190 +- .../src/Model/TemplateUpdateFilesResponse.php | 155 +- .../TemplateUpdateFilesResponseTemplate.php | 165 +- .../UnclaimedDraftCreateEmbeddedRequest.php | 364 ++-- ...DraftCreateEmbeddedWithTemplateRequest.php | 331 +-- .../src/Model/UnclaimedDraftCreateRequest.php | 302 +-- .../Model/UnclaimedDraftCreateResponse.php | 163 +- .../UnclaimedDraftEditAndResendRequest.php | 191 +- sdks/php/src/Model/UnclaimedDraftResponse.php | 183 +- sdks/php/src/Model/WarningResponse.php | 155 +- sdks/php/src/ObjectSerializer.php | 305 +-- translations/en.yaml | 84 +- 459 files changed, 24998 insertions(+), 21827 deletions(-) diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 818930290..304c1c17f 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1414,7 +1414,7 @@ paths: tags: - Fax summary: 'Get Fax' - description: 'Returns information about fax' + description: 'Returns information about a Fax' operationId: faxGet parameters: - @@ -1510,12 +1510,12 @@ paths: x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' delete: tags: - Fax summary: 'Delete Fax' - description: 'Deletes the specified Fax from the system.' + description: 'Deletes the specified Fax from the system' operationId: faxDelete parameters: - @@ -1610,7 +1610,7 @@ paths: tags: - Fax summary: 'Download Fax Files' - description: 'Downloads fax files' + description: 'Downloads files associated with a Fax' operationId: faxFiles parameters: - @@ -1706,7 +1706,7 @@ paths: x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' /fax_line/add_user: put: tags: @@ -1812,13 +1812,13 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/province and city.' + description: 'Returns a list of available area codes for a given state/province and city' operationId: faxLineAreaCodeGet parameters: - name: country in: query - description: 'Filter area codes by country.' + description: 'Filter area codes by country' required: true schema: type: string @@ -1830,7 +1830,7 @@ paths: - name: state in: query - description: 'Filter area codes by state.' + description: 'Filter area codes by state' schema: type: string enum: @@ -1888,7 +1888,7 @@ paths: - name: province in: query - description: 'Filter area codes by province.' + description: 'Filter area codes by province' schema: type: string enum: @@ -1908,7 +1908,7 @@ paths: - name: city in: query - description: 'Filter area codes by city.' + description: 'Filter area codes by city' schema: type: string responses: @@ -1992,13 +1992,13 @@ paths: x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' /fax_line/create: post: tags: - 'Fax Line' summary: 'Purchase Fax Line' - description: 'Purchases a new Fax Line.' + description: 'Purchases a new Fax Line' operationId: faxLineCreate requestBody: required: true @@ -2104,7 +2104,7 @@ paths: - name: number in: query - description: 'The Fax Line number.' + description: 'The Fax Line number' required: true schema: type: string @@ -2192,7 +2192,7 @@ paths: x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' delete: tags: - 'Fax Line' @@ -2305,7 +2305,7 @@ paths: - name: page in: query - description: Page + description: 'Which page number of the Fax Line List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2313,7 +2313,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2321,7 +2321,7 @@ paths: - name: show_team_lines in: query - description: 'Show team lines' + description: 'Include Fax Lines belonging to team members in the list' schema: type: boolean responses: @@ -2411,7 +2411,7 @@ paths: tags: - 'Fax Line' summary: 'Remove Fax Line Access' - description: 'Removes a user''s access to the specified Fax Line.' + description: 'Removes a user''s access to the specified Fax Line' operationId: faxLineRemoveUser requestBody: required: true @@ -2511,13 +2511,13 @@ paths: tags: - Fax summary: 'Lists Faxes' - description: 'Returns properties of multiple faxes' + description: 'Returns properties of multiple Faxes' operationId: faxList parameters: - name: page in: query - description: Page + description: 'Which page number of the Fax List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2526,7 +2526,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2620,7 +2620,7 @@ paths: tags: - Fax summary: 'Send Fax' - description: 'Action to prepare and send a fax' + description: 'Creates and sends a new Fax with the submitted file(s)' operationId: faxSend requestBody: required: true @@ -2718,7 +2718,7 @@ paths: $ref: examples/FaxSend.sh x-meta: seo: - title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + title: 'Send Fax | API Documentation | Dropbox Fax for Developers' description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' /oauth/token: post: @@ -7759,7 +7759,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: description: 'Account ID' @@ -7852,10 +7852,10 @@ components: - country properties: area_code: - description: 'Area code' + description: 'Area code of the new Fax Line' type: integer country: - description: Country + description: 'Country of the area code' type: string enum: - CA @@ -7867,10 +7867,10 @@ components: - Us - Uk city: - description: City + description: 'City of the area code' type: string account_id: - description: 'Account ID' + description: 'Account ID of the account that will be assigned this new Fax Line' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 type: object @@ -7879,7 +7879,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string type: object FaxLineRemoveUserRequest: @@ -7887,14 +7887,14 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: - description: 'Account ID' + description: 'Account ID of the user to remove access' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 email_address: - description: 'Email address' + description: 'Email address of the user to remove access' type: string format: email type: object @@ -7903,7 +7903,9 @@ components: - recipient properties: recipient: - description: 'Fax Send To Recipient' + description: |- + Recipient of the fax + Can be a phone number in E.164 format or email address type: string example: recipient@example.com sender: @@ -7911,13 +7913,19 @@ components: type: string example: sender@example.com files: - description: 'Fax File to Send' + description: |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: - description: 'Fax File URL to Send' + description: |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string @@ -7926,11 +7934,11 @@ components: type: boolean default: false cover_page_to: - description: 'Fax Cover Page for Recipient' + description: 'Fax cover page recipient information' type: string example: 'Recipient Name' cover_page_from: - description: 'Fax Cover Page for Sender' + description: 'Fax cover page sender information' type: string example: 'Sender Name' cover_page_message: @@ -13411,7 +13419,7 @@ components: value: $ref: examples/json/FaxLineListResponseExample.json FaxListResponseExample: - summary: 'Returns the properties and settings of multiple Faxes.' + summary: 'Returns the properties and settings of multiple Faxes' value: $ref: examples/json/FaxListResponseExample.json ReportCreateResponseExample: diff --git a/openapi.yaml b/openapi.yaml index d0dbb629b..7baa54892 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1414,7 +1414,7 @@ paths: tags: - Fax summary: 'Get Fax' - description: 'Returns information about fax' + description: 'Returns information about a Fax' operationId: faxGet parameters: - @@ -1510,12 +1510,12 @@ paths: x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' delete: tags: - Fax summary: 'Delete Fax' - description: 'Deletes the specified Fax from the system.' + description: 'Deletes the specified Fax from the system' operationId: faxDelete parameters: - @@ -1610,7 +1610,7 @@ paths: tags: - Fax summary: 'Download Fax Files' - description: 'Downloads fax files' + description: 'Downloads files associated with a Fax' operationId: faxFiles parameters: - @@ -1706,7 +1706,7 @@ paths: x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' /fax_line/add_user: put: tags: @@ -1812,13 +1812,13 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/province and city.' + description: 'Returns a list of available area codes for a given state/province and city' operationId: faxLineAreaCodeGet parameters: - name: country in: query - description: 'Filter area codes by country.' + description: 'Filter area codes by country' required: true schema: type: string @@ -1830,7 +1830,7 @@ paths: - name: state in: query - description: 'Filter area codes by state.' + description: 'Filter area codes by state' schema: type: string enum: @@ -1888,7 +1888,7 @@ paths: - name: province in: query - description: 'Filter area codes by province.' + description: 'Filter area codes by province' schema: type: string enum: @@ -1908,7 +1908,7 @@ paths: - name: city in: query - description: 'Filter area codes by city.' + description: 'Filter area codes by city' schema: type: string responses: @@ -1992,13 +1992,13 @@ paths: x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' /fax_line/create: post: tags: - 'Fax Line' summary: 'Purchase Fax Line' - description: 'Purchases a new Fax Line.' + description: 'Purchases a new Fax Line' operationId: faxLineCreate requestBody: required: true @@ -2104,7 +2104,7 @@ paths: - name: number in: query - description: 'The Fax Line number.' + description: 'The Fax Line number' required: true schema: type: string @@ -2192,7 +2192,7 @@ paths: x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' delete: tags: - 'Fax Line' @@ -2305,7 +2305,7 @@ paths: - name: page in: query - description: Page + description: 'Which page number of the Fax Line List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2313,7 +2313,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2321,7 +2321,7 @@ paths: - name: show_team_lines in: query - description: 'Show team lines' + description: 'Include Fax Lines belonging to team members in the list' schema: type: boolean responses: @@ -2411,7 +2411,7 @@ paths: tags: - 'Fax Line' summary: 'Remove Fax Line Access' - description: 'Removes a user''s access to the specified Fax Line.' + description: 'Removes a user''s access to the specified Fax Line' operationId: faxLineRemoveUser requestBody: required: true @@ -2511,13 +2511,13 @@ paths: tags: - Fax summary: 'Lists Faxes' - description: 'Returns properties of multiple faxes' + description: 'Returns properties of multiple Faxes' operationId: faxList parameters: - name: page in: query - description: Page + description: 'Which page number of the Fax List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2526,7 +2526,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2620,7 +2620,7 @@ paths: tags: - Fax summary: 'Send Fax' - description: 'Action to prepare and send a fax' + description: 'Creates and sends a new Fax with the submitted file(s)' operationId: faxSend requestBody: required: true @@ -2718,7 +2718,7 @@ paths: $ref: examples/FaxSend.sh x-meta: seo: - title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + title: 'Send Fax | API Documentation | Dropbox Fax for Developers' description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' /oauth/token: post: @@ -7759,7 +7759,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: description: 'Account ID' @@ -7852,10 +7852,10 @@ components: - country properties: area_code: - description: 'Area code' + description: 'Area code of the new Fax Line' type: integer country: - description: Country + description: 'Country of the area code' type: string enum: - CA @@ -7867,10 +7867,10 @@ components: - Us - Uk city: - description: City + description: 'City of the area code' type: string account_id: - description: 'Account ID' + description: 'Account ID of the account that will be assigned this new Fax Line' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 type: object @@ -7879,7 +7879,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string type: object FaxLineRemoveUserRequest: @@ -7887,14 +7887,14 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: - description: 'Account ID' + description: 'Account ID of the user to remove access' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 email_address: - description: 'Email address' + description: 'Email address of the user to remove access' type: string format: email type: object @@ -7903,7 +7903,9 @@ components: - recipient properties: recipient: - description: 'Fax Send To Recipient' + description: |- + Recipient of the fax + Can be a phone number in E.164 format or email address type: string example: recipient@example.com sender: @@ -7911,13 +7913,19 @@ components: type: string example: sender@example.com files: - description: 'Fax File to Send' + description: |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: - description: 'Fax File URL to Send' + description: |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string @@ -7926,11 +7934,11 @@ components: type: boolean default: false cover_page_to: - description: 'Fax Cover Page for Recipient' + description: 'Fax cover page recipient information' type: string example: 'Recipient Name' cover_page_from: - description: 'Fax Cover Page for Sender' + description: 'Fax cover page sender information' type: string example: 'Sender Name' cover_page_message: @@ -13389,7 +13397,7 @@ components: value: $ref: examples/json/FaxLineListResponseExample.json FaxListResponseExample: - summary: 'Returns the properties and settings of multiple Faxes.' + summary: 'Returns the properties and settings of multiple Faxes' value: $ref: examples/json/FaxListResponseExample.json ReportCreateResponseExample: diff --git a/sdks/dotnet/docs/FaxApi.md b/sdks/dotnet/docs/FaxApi.md index 207d25611..4368c0732 100644 --- a/sdks/dotnet/docs/FaxApi.md +++ b/sdks/dotnet/docs/FaxApi.md @@ -16,7 +16,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example ```csharp @@ -102,7 +102,7 @@ void (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example ```csharp @@ -197,7 +197,7 @@ catch (ApiException e) Get Fax -Returns information about fax +Returns information about a Fax ### Example ```csharp @@ -289,7 +289,7 @@ catch (ApiException e) Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example ```csharp @@ -352,8 +352,8 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **page** | **int?** | Page | [optional] [default to 1] | -| **pageSize** | **int?** | Page size | [optional] [default to 20] | +| **page** | **int?** | Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **int?** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -383,7 +383,7 @@ catch (ApiException e) Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example ```csharp diff --git a/sdks/dotnet/docs/FaxLineAddUserRequest.md b/sdks/dotnet/docs/FaxLineAddUserRequest.md index f89c0deef..705c9d91d 100644 --- a/sdks/dotnet/docs/FaxLineAddUserRequest.md +++ b/sdks/dotnet/docs/FaxLineAddUserRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | The Fax Line number. | **AccountId** | **string** | Account ID | [optional] **EmailAddress** | **string** | Email address | [optional] +**Number** | **string** | The Fax Line number | **AccountId** | **string** | Account ID | [optional] **EmailAddress** | **string** | Email address | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/FaxLineApi.md b/sdks/dotnet/docs/FaxLineApi.md index ea3109c8a..d914fb09b 100644 --- a/sdks/dotnet/docs/FaxLineApi.md +++ b/sdks/dotnet/docs/FaxLineApi.md @@ -113,7 +113,7 @@ catch (ApiException e) Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Example ```csharp @@ -173,10 +173,10 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **country** | **string** | Filter area codes by country. | | -| **state** | **string?** | Filter area codes by state. | [optional] | -| **province** | **string?** | Filter area codes by province. | [optional] | -| **city** | **string?** | Filter area codes by city. | [optional] | +| **country** | **string** | Filter area codes by country | | +| **state** | **string?** | Filter area codes by state | [optional] | +| **province** | **string?** | Filter area codes by province | [optional] | +| **city** | **string?** | Filter area codes by city | [optional] | ### Return type @@ -206,7 +206,7 @@ catch (ApiException e) Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example ```csharp @@ -451,7 +451,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **number** | **string** | The Fax Line number. | | +| **number** | **string** | The Fax Line number | | ### Return type @@ -542,9 +542,9 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **accountId** | **string?** | Account ID | [optional] | -| **page** | **int?** | Page | [optional] [default to 1] | -| **pageSize** | **int?** | Page size | [optional] [default to 20] | -| **showTeamLines** | **bool?** | Show team lines | [optional] | +| **page** | **int?** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **int?** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **showTeamLines** | **bool?** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -574,7 +574,7 @@ catch (ApiException e) Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example ```csharp diff --git a/sdks/dotnet/docs/FaxLineCreateRequest.md b/sdks/dotnet/docs/FaxLineCreateRequest.md index 21d3ffc88..d8bf8c4d9 100644 --- a/sdks/dotnet/docs/FaxLineCreateRequest.md +++ b/sdks/dotnet/docs/FaxLineCreateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AreaCode** | **int** | Area code | **Country** | **string** | Country | **City** | **string** | City | [optional] **AccountId** | **string** | Account ID | [optional] +**AreaCode** | **int** | Area code of the new Fax Line | **Country** | **string** | Country of the area code | **City** | **string** | City of the area code | [optional] **AccountId** | **string** | Account ID of the account that will be assigned this new Fax Line | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/FaxLineDeleteRequest.md b/sdks/dotnet/docs/FaxLineDeleteRequest.md index 673880d28..1d8885b58 100644 --- a/sdks/dotnet/docs/FaxLineDeleteRequest.md +++ b/sdks/dotnet/docs/FaxLineDeleteRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | The Fax Line number. | +**Number** | **string** | The Fax Line number | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/FaxLineRemoveUserRequest.md b/sdks/dotnet/docs/FaxLineRemoveUserRequest.md index 0d73414a7..3be0e7bdb 100644 --- a/sdks/dotnet/docs/FaxLineRemoveUserRequest.md +++ b/sdks/dotnet/docs/FaxLineRemoveUserRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | The Fax Line number. | **AccountId** | **string** | Account ID | [optional] **EmailAddress** | **string** | Email address | [optional] +**Number** | **string** | The Fax Line number | **AccountId** | **string** | Account ID of the user to remove access | [optional] **EmailAddress** | **string** | Email address of the user to remove access | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/FaxSendRequest.md b/sdks/dotnet/docs/FaxSendRequest.md index b02d7f0b8..371c7c062 100644 --- a/sdks/dotnet/docs/FaxSendRequest.md +++ b/sdks/dotnet/docs/FaxSendRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Recipient** | **string** | Fax Send To Recipient | **Sender** | **string** | Fax Send From Sender (used only with fax number) | [optional] **Files** | **List<System.IO.Stream>** | Fax File to Send | [optional] **FileUrls** | **List<string>** | Fax File URL to Send | [optional] **TestMode** | **bool** | API Test Mode Setting | [optional] [default to false]**CoverPageTo** | **string** | Fax Cover Page for Recipient | [optional] **CoverPageFrom** | **string** | Fax Cover Page for Sender | [optional] **CoverPageMessage** | **string** | Fax Cover Page Message | [optional] **Title** | **string** | Fax Title | [optional] +**Recipient** | **string** | Recipient of the fax Can be a phone number in E.164 format or email address | **Sender** | **string** | Fax Send From Sender (used only with fax number) | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **TestMode** | **bool** | API Test Mode Setting | [optional] [default to false]**CoverPageTo** | **string** | Fax cover page recipient information | [optional] **CoverPageFrom** | **string** | Fax cover page sender information | [optional] **CoverPageMessage** | **string** | Fax Cover Page Message | [optional] **Title** | **string** | Fax Title | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs index 5ff4251f5..096d3bf66 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs @@ -31,7 +31,7 @@ public interface IFaxApiSync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -43,7 +43,7 @@ public interface IFaxApiSync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -54,7 +54,7 @@ public interface IFaxApiSync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -66,7 +66,7 @@ public interface IFaxApiSync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -77,7 +77,7 @@ public interface IFaxApiSync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -89,7 +89,7 @@ public interface IFaxApiSync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -100,11 +100,11 @@ public interface IFaxApiSync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// FaxListResponse FaxListResponse FaxList(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0); @@ -113,11 +113,11 @@ public interface IFaxApiSync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// ApiResponse of FaxListResponse ApiResponse FaxListWithHttpInfo(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0); @@ -125,7 +125,7 @@ public interface IFaxApiSync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -137,7 +137,7 @@ public interface IFaxApiSync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -157,7 +157,7 @@ public interface IFaxApiAsync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -170,7 +170,7 @@ public interface IFaxApiAsync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -182,7 +182,7 @@ public interface IFaxApiAsync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -195,7 +195,7 @@ public interface IFaxApiAsync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -207,7 +207,7 @@ public interface IFaxApiAsync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -220,7 +220,7 @@ public interface IFaxApiAsync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -232,11 +232,11 @@ public interface IFaxApiAsync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxListResponse @@ -246,11 +246,11 @@ public interface IFaxApiAsync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxListResponse) @@ -259,7 +259,7 @@ public interface IFaxApiAsync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -272,7 +272,7 @@ public interface IFaxApiAsync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -401,7 +401,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -413,7 +413,7 @@ public void FaxDelete(string faxId, int operationIndex = 0) } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -476,7 +476,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -489,7 +489,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -555,7 +555,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -568,7 +568,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -632,7 +632,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -646,7 +646,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -713,7 +713,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -726,7 +726,7 @@ public FaxGetResponse FaxGet(string faxId, int operationIndex = 0) } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -789,7 +789,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -803,7 +803,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -869,11 +869,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// FaxListResponse public FaxListResponse FaxList(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0) @@ -883,11 +883,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// ApiResponse of FaxListResponse public Dropbox.Sign.Client.ApiResponse FaxListWithHttpInfo(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0) @@ -948,11 +948,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxListResponse @@ -963,11 +963,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxListResponse) @@ -1031,7 +1031,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -1044,7 +1044,7 @@ public FaxGetResponse FaxSend(FaxSendRequest faxSendRequest, int operationIndex } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -1115,7 +1115,7 @@ public Dropbox.Sign.Client.ApiResponse FaxSendWithHttpInfo(FaxSe } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -1129,7 +1129,7 @@ public Dropbox.Sign.Client.ApiResponse FaxSendWithHttpInfo(FaxSe } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs index 38f303895..127f2e4d7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs @@ -54,13 +54,13 @@ public interface IFaxLineApiSync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// FaxLineAreaCodeGetResponse FaxLineAreaCodeGetResponse FaxLineAreaCodeGet(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0); @@ -69,13 +69,13 @@ public interface IFaxLineApiSync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// ApiResponse of FaxLineAreaCodeGetResponse ApiResponse FaxLineAreaCodeGetWithHttpInfo(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0); @@ -83,7 +83,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -95,7 +95,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -132,7 +132,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// FaxLineResponse FaxLineResponse FaxLineGet(string number, int operationIndex = 0); @@ -144,7 +144,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// ApiResponse of FaxLineResponse ApiResponse FaxLineGetWithHttpInfo(string number, int operationIndex = 0); @@ -156,9 +156,9 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// FaxLineListResponse FaxLineListResponse FaxLineList(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0); @@ -171,9 +171,9 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// ApiResponse of FaxLineListResponse ApiResponse FaxLineListWithHttpInfo(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0); @@ -181,7 +181,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -193,7 +193,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -238,13 +238,13 @@ public interface IFaxLineApiAsync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineAreaCodeGetResponse @@ -254,13 +254,13 @@ public interface IFaxLineApiAsync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineAreaCodeGetResponse) @@ -269,7 +269,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -282,7 +282,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -322,7 +322,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineResponse @@ -335,7 +335,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineResponse) @@ -348,9 +348,9 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineListResponse @@ -364,9 +364,9 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineListResponse) @@ -375,7 +375,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -388,7 +388,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -689,13 +689,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// FaxLineAreaCodeGetResponse public FaxLineAreaCodeGetResponse FaxLineAreaCodeGet(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0) @@ -705,13 +705,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// ApiResponse of FaxLineAreaCodeGetResponse public Dropbox.Sign.Client.ApiResponse FaxLineAreaCodeGetWithHttpInfo(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0) @@ -783,13 +783,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineAreaCodeGetResponse @@ -800,13 +800,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineAreaCodeGetResponse) @@ -881,7 +881,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -894,7 +894,7 @@ public FaxLineResponse FaxLineCreate(FaxLineCreateRequest faxLineCreateRequest, } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -965,7 +965,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineCreateWithHttpInf } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -979,7 +979,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineCreateWithHttpInf } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -1226,7 +1226,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineDeleteWithHttpInfo(FaxLine /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// FaxLineResponse public FaxLineResponse FaxLineGet(string number, int operationIndex = 0) @@ -1239,7 +1239,7 @@ public FaxLineResponse FaxLineGet(string number, int operationIndex = 0) /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// ApiResponse of FaxLineResponse public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(string number, int operationIndex = 0) @@ -1302,7 +1302,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineResponse @@ -1316,7 +1316,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineResponse) @@ -1383,9 +1383,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// FaxLineListResponse public FaxLineListResponse FaxLineList(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0) @@ -1399,9 +1399,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// ApiResponse of FaxLineListResponse public Dropbox.Sign.Client.ApiResponse FaxLineListWithHttpInfo(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0) @@ -1474,9 +1474,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineListResponse @@ -1491,9 +1491,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineListResponse) @@ -1565,7 +1565,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -1578,7 +1578,7 @@ public FaxLineResponse FaxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -1649,7 +1649,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineRemoveUserWithHtt } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -1663,7 +1663,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineRemoveUserWithHtt } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs index 55509a4bc..fbbc7084e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs @@ -41,7 +41,7 @@ protected FaxLineAddUserRequest() { } /// /// Initializes a new instance of the class. /// - /// The Fax Line number. (required). + /// The Fax Line number (required). /// Account ID. /// Email address. public FaxLineAddUserRequest(string number = default(string), string accountId = default(string), string emailAddress = default(string)) @@ -74,9 +74,9 @@ public static FaxLineAddUserRequest Init(string jsonData) } /// - /// The Fax Line number. + /// The Fax Line number /// - /// The Fax Line number. + /// The Fax Line number [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] public string Number { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs index 733cab7f8..ad5c88445 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs @@ -34,9 +34,9 @@ namespace Dropbox.Sign.Model public partial class FaxLineCreateRequest : IEquatable, IValidatableObject { /// - /// Country + /// Country of the area code /// - /// Country + /// Country of the area code [JsonConverter(typeof(StringEnumConverter))] public enum CountryEnum { @@ -61,9 +61,9 @@ public enum CountryEnum /// - /// Country + /// Country of the area code /// - /// Country + /// Country of the area code [DataMember(Name = "country", IsRequired = true, EmitDefaultValue = true)] public CountryEnum Country { get; set; } /// @@ -74,10 +74,10 @@ protected FaxLineCreateRequest() { } /// /// Initializes a new instance of the class. /// - /// Area code (required). - /// Country (required). - /// City. - /// Account ID. + /// Area code of the new Fax Line (required). + /// Country of the area code (required). + /// City of the area code. + /// Account ID of the account that will be assigned this new Fax Line. public FaxLineCreateRequest(int areaCode = default(int), CountryEnum country = default(CountryEnum), string city = default(string), string accountId = default(string)) { @@ -104,23 +104,23 @@ public static FaxLineCreateRequest Init(string jsonData) } /// - /// Area code + /// Area code of the new Fax Line /// - /// Area code + /// Area code of the new Fax Line [DataMember(Name = "area_code", IsRequired = true, EmitDefaultValue = true)] public int AreaCode { get; set; } /// - /// City + /// City of the area code /// - /// City + /// City of the area code [DataMember(Name = "city", EmitDefaultValue = true)] public string City { get; set; } /// - /// Account ID + /// Account ID of the account that will be assigned this new Fax Line /// - /// Account ID + /// Account ID of the account that will be assigned this new Fax Line /// ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs index cb5a27378..5bc3e961d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs @@ -41,7 +41,7 @@ protected FaxLineDeleteRequest() { } /// /// Initializes a new instance of the class. /// - /// The Fax Line number. (required). + /// The Fax Line number (required). public FaxLineDeleteRequest(string number = default(string)) { @@ -70,9 +70,9 @@ public static FaxLineDeleteRequest Init(string jsonData) } /// - /// The Fax Line number. + /// The Fax Line number /// - /// The Fax Line number. + /// The Fax Line number [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] public string Number { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs index eed6d36a9..1347d8250 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs @@ -41,9 +41,9 @@ protected FaxLineRemoveUserRequest() { } /// /// Initializes a new instance of the class. /// - /// The Fax Line number. (required). - /// Account ID. - /// Email address. + /// The Fax Line number (required). + /// Account ID of the user to remove access. + /// Email address of the user to remove access. public FaxLineRemoveUserRequest(string number = default(string), string accountId = default(string), string emailAddress = default(string)) { @@ -74,24 +74,24 @@ public static FaxLineRemoveUserRequest Init(string jsonData) } /// - /// The Fax Line number. + /// The Fax Line number /// - /// The Fax Line number. + /// The Fax Line number [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] public string Number { get; set; } /// - /// Account ID + /// Account ID of the user to remove access /// - /// Account ID + /// Account ID of the user to remove access /// ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } /// - /// Email address + /// Email address of the user to remove access /// - /// Email address + /// Email address of the user to remove access [DataMember(Name = "email_address", EmitDefaultValue = true)] public string EmailAddress { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs index e4d42e6d4..d5eddb1b5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs @@ -41,13 +41,13 @@ protected FaxSendRequest() { } /// /// Initializes a new instance of the class. /// - /// Fax Send To Recipient (required). + /// Recipient of the fax Can be a phone number in E.164 format or email address (required). /// Fax Send From Sender (used only with fax number). - /// Fax File to Send. - /// Fax File URL to Send. + /// Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.. + /// Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.. /// API Test Mode Setting (default to false). - /// Fax Cover Page for Recipient. - /// Fax Cover Page for Sender. + /// Fax cover page recipient information. + /// Fax cover page sender information. /// Fax Cover Page Message. /// Fax Title. public FaxSendRequest(string recipient = default(string), string sender = default(string), List files = default(List), List fileUrls = default(List), bool testMode = false, string coverPageTo = default(string), string coverPageFrom = default(string), string coverPageMessage = default(string), string title = default(string)) @@ -86,9 +86,9 @@ public static FaxSendRequest Init(string jsonData) } /// - /// Fax Send To Recipient + /// Recipient of the fax Can be a phone number in E.164 format or email address /// - /// Fax Send To Recipient + /// Recipient of the fax Can be a phone number in E.164 format or email address /// recipient@example.com [DataMember(Name = "recipient", IsRequired = true, EmitDefaultValue = true)] public string Recipient { get; set; } @@ -102,16 +102,16 @@ public static FaxSendRequest Init(string jsonData) public string Sender { get; set; } /// - /// Fax File to Send + /// Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. /// - /// Fax File to Send + /// Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. [DataMember(Name = "files", EmitDefaultValue = true)] public List Files { get; set; } /// - /// Fax File URL to Send + /// Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. /// - /// Fax File URL to Send + /// Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. [DataMember(Name = "file_urls", EmitDefaultValue = true)] public List FileUrls { get; set; } @@ -123,17 +123,17 @@ public static FaxSendRequest Init(string jsonData) public bool TestMode { get; set; } /// - /// Fax Cover Page for Recipient + /// Fax cover page recipient information /// - /// Fax Cover Page for Recipient + /// Fax cover page recipient information /// Recipient Name [DataMember(Name = "cover_page_to", EmitDefaultValue = true)] public string CoverPageTo { get; set; } /// - /// Fax Cover Page for Sender + /// Fax cover page sender information /// - /// Fax Cover Page for Sender + /// Fax cover page sender information /// Sender Name [DataMember(Name = "cover_page_from", EmitDefaultValue = true)] public string CoverPageFrom { get; set; } diff --git a/sdks/java-v1/docs/FaxApi.md b/sdks/java-v1/docs/FaxApi.md index 16102c5a4..5166ea29c 100644 --- a/sdks/java-v1/docs/FaxApi.md +++ b/sdks/java-v1/docs/FaxApi.md @@ -18,7 +18,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -84,7 +84,7 @@ null (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -153,7 +153,7 @@ public class Example { Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -221,7 +221,7 @@ public class Example { Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -262,8 +262,8 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] + **page** | **Integer**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] ### Return type @@ -291,7 +291,7 @@ public class Example { Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/java-v1/docs/FaxLineAddUserRequest.md b/sdks/java-v1/docs/FaxLineAddUserRequest.md index 1c9e997f9..4023bd024 100644 --- a/sdks/java-v1/docs/FaxLineAddUserRequest.md +++ b/sdks/java-v1/docs/FaxLineAddUserRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `accountId` | ```String``` | Account ID | | | `emailAddress` | ```String``` | Email address | | diff --git a/sdks/java-v1/docs/FaxLineApi.md b/sdks/java-v1/docs/FaxLineApi.md index 3aa4f8c4c..418bfc558 100644 --- a/sdks/java-v1/docs/FaxLineApi.md +++ b/sdks/java-v1/docs/FaxLineApi.md @@ -91,7 +91,7 @@ public class Example { Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -130,10 +130,10 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **country** | **String**| Filter area codes by country. | [enum: CA, US, UK] - **state** | **String**| Filter area codes by state. | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] - **province** | **String**| Filter area codes by province. | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] - **city** | **String**| Filter area codes by city. | [optional] + **country** | **String**| Filter area codes by country | [enum: CA, US, UK] + **state** | **String**| Filter area codes by state | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] + **province** | **String**| Filter area codes by province | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] + **city** | **String**| Filter area codes by city | [optional] ### Return type @@ -161,7 +161,7 @@ public class Example { Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -340,7 +340,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **number** | **String**| The Fax Line number. | + **number** | **String**| The Fax Line number | ### Return type @@ -408,9 +408,9 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| **accountId** | **String**| Account ID | [optional] - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] - **showTeamLines** | **Boolean**| Show team lines | [optional] + **page** | **Integer**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] + **showTeamLines** | **Boolean**| Include Fax Lines belonging to team members in the list | [optional] ### Return type @@ -438,7 +438,7 @@ public class Example { Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/java-v1/docs/FaxLineCreateRequest.md b/sdks/java-v1/docs/FaxLineCreateRequest.md index da9ba3953..7fd1be6bf 100644 --- a/sdks/java-v1/docs/FaxLineCreateRequest.md +++ b/sdks/java-v1/docs/FaxLineCreateRequest.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `areaCode`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country | | -| `city` | ```String``` | City | | -| `accountId` | ```String``` | Account ID | | +| `areaCode`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `accountId` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/sdks/java-v1/docs/FaxLineDeleteRequest.md b/sdks/java-v1/docs/FaxLineDeleteRequest.md index de1748fa1..4b45b339f 100644 --- a/sdks/java-v1/docs/FaxLineDeleteRequest.md +++ b/sdks/java-v1/docs/FaxLineDeleteRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/sdks/java-v1/docs/FaxLineRemoveUserRequest.md b/sdks/java-v1/docs/FaxLineRemoveUserRequest.md index 51d81b8fa..8e55d572d 100644 --- a/sdks/java-v1/docs/FaxLineRemoveUserRequest.md +++ b/sdks/java-v1/docs/FaxLineRemoveUserRequest.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `accountId` | ```String``` | Account ID | | -| `emailAddress` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `accountId` | ```String``` | Account ID of the user to remove access | | +| `emailAddress` | ```String``` | Email address of the user to remove access | | diff --git a/sdks/java-v1/docs/FaxSendRequest.md b/sdks/java-v1/docs/FaxSendRequest.md index 5b939a0af..65b105756 100644 --- a/sdks/java-v1/docs/FaxSendRequest.md +++ b/sdks/java-v1/docs/FaxSendRequest.md @@ -8,13 +8,13 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List``` | Fax File to Send | | -| `fileUrls` | ```List``` | Fax File URL to Send | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `testMode` | ```Boolean``` | API Test Mode Setting | | -| `coverPageTo` | ```String``` | Fax Cover Page for Recipient | | -| `coverPageFrom` | ```String``` | Fax Cover Page for Sender | | +| `coverPageTo` | ```String``` | Fax cover page recipient information | | +| `coverPageFrom` | ```String``` | Fax cover page sender information | | | `coverPageMessage` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java index bf79b4f83..9e0041637 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -49,7 +49,7 @@ public void setApiClient(ApiClient apiClient) { } /** - * Delete Fax. Deletes the specified Fax from the system. + * Delete Fax. Deletes the specified Fax from the system * * @param faxId Fax ID (required) * @throws ApiException if fails to make API call @@ -65,7 +65,7 @@ public void faxDelete(String faxId) throws ApiException { } /** - * Delete Fax. Deletes the specified Fax from the system. + * Delete Fax. Deletes the specified Fax from the system * * @param faxId Fax ID (required) * @return ApiResponse<Void> @@ -113,7 +113,7 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException } /** - * Download Fax Files. Downloads fax files + * Download Fax Files. Downloads files associated with a Fax * * @param faxId Fax ID (required) * @return File @@ -130,7 +130,7 @@ public File faxFiles(String faxId) throws ApiException { } /** - * Download Fax Files. Downloads fax files + * Download Fax Files. Downloads files associated with a Fax * * @param faxId Fax ID (required) * @return ApiResponse<File> @@ -180,7 +180,7 @@ public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException } /** - * Get Fax. Returns information about fax + * Get Fax. Returns information about a Fax * * @param faxId Fax ID (required) * @return FaxGetResponse @@ -197,7 +197,7 @@ public FaxGetResponse faxGet(String faxId) throws ApiException { } /** - * Get Fax. Returns information about fax + * Get Fax. Returns information about a Fax * * @param faxId Fax ID (required) * @return ApiResponse<FaxGetResponse> @@ -246,10 +246,12 @@ public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiEx } /** - * Lists Faxes. Returns properties of multiple faxes + * Lists Faxes. Returns properties of multiple Faxes * - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * @param page Which page number of the Fax List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) * @return FaxListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -302,10 +304,12 @@ public ApiResponse faxListWithHttpInfo(Integer page) throws Api } /** - * Lists Faxes. Returns properties of multiple faxes + * Lists Faxes. Returns properties of multiple Faxes * - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * @param page Which page number of the Fax List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) * @return ApiResponse<FaxListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -354,7 +358,7 @@ public ApiResponse faxListWithHttpInfo(Integer page, Integer pa } /** - * Send Fax. Action to prepare and send a fax + * Send Fax. Creates and sends a new Fax with the submitted file(s) * * @param faxSendRequest (required) * @return FaxGetResponse @@ -371,7 +375,7 @@ public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException } /** - * Send Fax. Action to prepare and send a fax + * Send Fax. Creates and sends a new Fax with the submitted file(s) * * @param faxSendRequest (required) * @return ApiResponse<FaxGetResponse> diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java index 6f35fb7aa..e8736ad65 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -120,13 +120,13 @@ public ApiResponse faxLineAddUserWithHttpInfo( } /** - * Get Available Fax Line Area Codes. Returns a response with the area codes available for a - * given state/province and city. + * Get Available Fax Line Area Codes. Returns a list of available area codes for a given + * state/province and city * - * @param country Filter area codes by country. (required) - * @param state Filter area codes by state. (optional) - * @param province Filter area codes by province. (optional) - * @param city Filter area codes by city. (optional) + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return FaxLineAreaCodeGetResponse * @throws ApiException if fails to make API call * @http.response.details @@ -207,13 +207,13 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo( } /** - * Get Available Fax Line Area Codes. Returns a response with the area codes available for a - * given state/province and city. + * Get Available Fax Line Area Codes. Returns a list of available area codes for a given + * state/province and city * - * @param country Filter area codes by country. (required) - * @param state Filter area codes by state. (optional) - * @param province Filter area codes by province. (optional) - * @param city Filter area codes by city. (optional) + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return ApiResponse<FaxLineAreaCodeGetResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -266,7 +266,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo( } /** - * Purchase Fax Line. Purchases a new Fax Line. + * Purchase Fax Line. Purchases a new Fax Line * * @param faxLineCreateRequest (required) * @return FaxLineResponse @@ -284,7 +284,7 @@ public FaxLineResponse faxLineCreate(FaxLineCreateRequest faxLineCreateRequest) } /** - * Purchase Fax Line. Purchases a new Fax Line. + * Purchase Fax Line. Purchases a new Fax Line * * @param faxLineCreateRequest (required) * @return ApiResponse<FaxLineResponse> @@ -401,7 +401,7 @@ public ApiResponse faxLineDeleteWithHttpInfo(FaxLineDeleteRequest faxLineD /** * Get Fax Line. Returns the properties and settings of a Fax Line. * - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return FaxLineResponse * @throws ApiException if fails to make API call * @http.response.details @@ -418,7 +418,7 @@ public FaxLineResponse faxLineGet(String number) throws ApiException { /** * Get Fax Line. Returns the properties and settings of a Fax Line. * - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -468,9 +468,11 @@ public ApiResponse faxLineGetWithHttpInfo(String number) throws * List Fax Lines. Returns the properties and settings of multiple Fax Lines. * * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return FaxLineListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -578,9 +580,11 @@ public ApiResponse faxLineListWithHttpInfo( * List Fax Lines. Returns the properties and settings of multiple Fax Lines. * * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return ApiResponse<FaxLineListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -634,7 +638,7 @@ public ApiResponse faxLineListWithHttpInfo( } /** - * Remove Fax Line Access. Removes a user's access to the specified Fax Line. + * Remove Fax Line Access. Removes a user's access to the specified Fax Line * * @param faxLineRemoveUserRequest (required) * @return FaxLineResponse @@ -652,7 +656,7 @@ public FaxLineResponse faxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU } /** - * Remove Fax Line Access. Removes a user's access to the specified Fax Line. + * Remove Fax Line Access. Removes a user's access to the specified Fax Line * * @param faxLineRemoveUserRequest (required) * @return ApiResponse<FaxLineResponse> diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java index f1d852493..d86167c2e 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java @@ -66,7 +66,7 @@ public FaxLineAddUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * * @return number */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java index 7f18d7bc7..e75ea0d36 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java @@ -40,7 +40,7 @@ public class FaxLineCreateRequest { public static final String JSON_PROPERTY_AREA_CODE = "area_code"; private Integer areaCode; - /** Country */ + /** Country of the area code */ public enum CountryEnum { CA("CA"), @@ -106,7 +106,7 @@ public FaxLineCreateRequest areaCode(Integer areaCode) { } /** - * Area code + * Area code of the new Fax Line * * @return areaCode */ @@ -129,7 +129,7 @@ public FaxLineCreateRequest country(CountryEnum country) { } /** - * Country + * Country of the area code * * @return country */ @@ -152,7 +152,7 @@ public FaxLineCreateRequest city(String city) { } /** - * City + * City of the area code * * @return city */ @@ -174,7 +174,7 @@ public FaxLineCreateRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the account that will be assigned this new Fax Line * * @return accountId */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java index 7a7bfdd5f..efd21bff3 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java @@ -55,7 +55,7 @@ public FaxLineDeleteRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * * @return number */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java index 0347f5886..14d15e0bd 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java @@ -67,7 +67,7 @@ public FaxLineRemoveUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * * @return number */ @@ -90,7 +90,7 @@ public FaxLineRemoveUserRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the user to remove access * * @return accountId */ @@ -112,7 +112,7 @@ public FaxLineRemoveUserRequest emailAddress(String emailAddress) { } /** - * Email address + * Email address of the user to remove access * * @return emailAddress */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java index 571ba92f8..b668e9ff7 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java @@ -92,7 +92,7 @@ public FaxSendRequest recipient(String recipient) { } /** - * Fax Send To Recipient + * Recipient of the fax Can be a phone number in E.164 format or email address * * @return recipient */ @@ -145,7 +145,8 @@ public FaxSendRequest addFilesItem(File filesItem) { } /** - * Fax File to Send + * Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either + * **files** or **file_urls[]**, but not both. * * @return files */ @@ -175,7 +176,8 @@ public FaxSendRequest addFileUrlsItem(String fileUrlsItem) { } /** - * Fax File URL to Send + * Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint + * requires either **files** or **file_urls[]**, but not both. * * @return fileUrls */ @@ -219,7 +221,7 @@ public FaxSendRequest coverPageTo(String coverPageTo) { } /** - * Fax Cover Page for Recipient + * Fax cover page recipient information * * @return coverPageTo */ @@ -241,7 +243,7 @@ public FaxSendRequest coverPageFrom(String coverPageFrom) { } /** - * Fax Cover Page for Sender + * Fax cover page sender information * * @return coverPageFrom */ diff --git a/sdks/java-v2/docs/FaxApi.md b/sdks/java-v2/docs/FaxApi.md index 16102c5a4..5166ea29c 100644 --- a/sdks/java-v2/docs/FaxApi.md +++ b/sdks/java-v2/docs/FaxApi.md @@ -18,7 +18,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -84,7 +84,7 @@ null (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -153,7 +153,7 @@ public class Example { Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -221,7 +221,7 @@ public class Example { Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -262,8 +262,8 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] + **page** | **Integer**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] ### Return type @@ -291,7 +291,7 @@ public class Example { Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/java-v2/docs/FaxLineAddUserRequest.md b/sdks/java-v2/docs/FaxLineAddUserRequest.md index 1c9e997f9..4023bd024 100644 --- a/sdks/java-v2/docs/FaxLineAddUserRequest.md +++ b/sdks/java-v2/docs/FaxLineAddUserRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `accountId` | ```String``` | Account ID | | | `emailAddress` | ```String``` | Email address | | diff --git a/sdks/java-v2/docs/FaxLineApi.md b/sdks/java-v2/docs/FaxLineApi.md index 3aa4f8c4c..418bfc558 100644 --- a/sdks/java-v2/docs/FaxLineApi.md +++ b/sdks/java-v2/docs/FaxLineApi.md @@ -91,7 +91,7 @@ public class Example { Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -130,10 +130,10 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **country** | **String**| Filter area codes by country. | [enum: CA, US, UK] - **state** | **String**| Filter area codes by state. | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] - **province** | **String**| Filter area codes by province. | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] - **city** | **String**| Filter area codes by city. | [optional] + **country** | **String**| Filter area codes by country | [enum: CA, US, UK] + **state** | **String**| Filter area codes by state | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] + **province** | **String**| Filter area codes by province | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] + **city** | **String**| Filter area codes by city | [optional] ### Return type @@ -161,7 +161,7 @@ public class Example { Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -340,7 +340,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **number** | **String**| The Fax Line number. | + **number** | **String**| The Fax Line number | ### Return type @@ -408,9 +408,9 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| **accountId** | **String**| Account ID | [optional] - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] - **showTeamLines** | **Boolean**| Show team lines | [optional] + **page** | **Integer**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] + **showTeamLines** | **Boolean**| Include Fax Lines belonging to team members in the list | [optional] ### Return type @@ -438,7 +438,7 @@ public class Example { Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/java-v2/docs/FaxLineCreateRequest.md b/sdks/java-v2/docs/FaxLineCreateRequest.md index da9ba3953..7fd1be6bf 100644 --- a/sdks/java-v2/docs/FaxLineCreateRequest.md +++ b/sdks/java-v2/docs/FaxLineCreateRequest.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `areaCode`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country | | -| `city` | ```String``` | City | | -| `accountId` | ```String``` | Account ID | | +| `areaCode`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `accountId` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/sdks/java-v2/docs/FaxLineDeleteRequest.md b/sdks/java-v2/docs/FaxLineDeleteRequest.md index de1748fa1..4b45b339f 100644 --- a/sdks/java-v2/docs/FaxLineDeleteRequest.md +++ b/sdks/java-v2/docs/FaxLineDeleteRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/sdks/java-v2/docs/FaxLineRemoveUserRequest.md b/sdks/java-v2/docs/FaxLineRemoveUserRequest.md index 51d81b8fa..8e55d572d 100644 --- a/sdks/java-v2/docs/FaxLineRemoveUserRequest.md +++ b/sdks/java-v2/docs/FaxLineRemoveUserRequest.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `accountId` | ```String``` | Account ID | | -| `emailAddress` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `accountId` | ```String``` | Account ID of the user to remove access | | +| `emailAddress` | ```String``` | Email address of the user to remove access | | diff --git a/sdks/java-v2/docs/FaxSendRequest.md b/sdks/java-v2/docs/FaxSendRequest.md index 5b939a0af..65b105756 100644 --- a/sdks/java-v2/docs/FaxSendRequest.md +++ b/sdks/java-v2/docs/FaxSendRequest.md @@ -8,13 +8,13 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List``` | Fax File to Send | | -| `fileUrls` | ```List``` | Fax File URL to Send | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `testMode` | ```Boolean``` | API Test Mode Setting | | -| `coverPageTo` | ```String``` | Fax Cover Page for Recipient | | -| `coverPageFrom` | ```String``` | Fax Cover Page for Sender | | +| `coverPageTo` | ```String``` | Fax cover page recipient information | | +| `coverPageFrom` | ```String``` | Fax cover page sender information | | | `coverPageMessage` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java index a42076f38..2bb22a100 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -52,7 +52,7 @@ public void setApiClient(ApiClient apiClient) { /** * Delete Fax. - * Deletes the specified Fax from the system. + * Deletes the specified Fax from the system * @param faxId Fax ID (required) * @throws ApiException if fails to make API call * @http.response.details @@ -69,7 +69,7 @@ public void faxDelete(String faxId) throws ApiException { /** * Delete Fax. - * Deletes the specified Fax from the system. + * Deletes the specified Fax from the system * @param faxId Fax ID (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -115,7 +115,7 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException } /** * Download Fax Files. - * Downloads fax files + * Downloads files associated with a Fax * @param faxId Fax ID (required) * @return File * @throws ApiException if fails to make API call @@ -133,7 +133,7 @@ public File faxFiles(String faxId) throws ApiException { /** * Download Fax Files. - * Downloads fax files + * Downloads files associated with a Fax * @param faxId Fax ID (required) * @return ApiResponse<File> * @throws ApiException if fails to make API call @@ -180,7 +180,7 @@ public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException } /** * Get Fax. - * Returns information about fax + * Returns information about a Fax * @param faxId Fax ID (required) * @return FaxGetResponse * @throws ApiException if fails to make API call @@ -198,7 +198,7 @@ public FaxGetResponse faxGet(String faxId) throws ApiException { /** * Get Fax. - * Returns information about fax + * Returns information about a Fax * @param faxId Fax ID (required) * @return ApiResponse<FaxGetResponse> * @throws ApiException if fails to make API call @@ -245,9 +245,9 @@ public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiEx } /** * Lists Faxes. - * Returns properties of multiple faxes - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * Returns properties of multiple Faxes + * @param page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return FaxListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -303,9 +303,9 @@ public ApiResponse faxListWithHttpInfo(Integer page) throws Api /** * Lists Faxes. - * Returns properties of multiple faxes - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * Returns properties of multiple Faxes + * @param page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return ApiResponse<FaxListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -354,7 +354,7 @@ public ApiResponse faxListWithHttpInfo(Integer page, Integer pa } /** * Send Fax. - * Action to prepare and send a fax + * Creates and sends a new Fax with the submitted file(s) * @param faxSendRequest (required) * @return FaxGetResponse * @throws ApiException if fails to make API call @@ -372,7 +372,7 @@ public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException /** * Send Fax. - * Action to prepare and send a fax + * Creates and sends a new Fax with the submitted file(s) * @param faxSendRequest (required) * @return ApiResponse<FaxGetResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java index c6d9a5eea..53d1a3bbc 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -116,11 +116,11 @@ public ApiResponse faxLineAddUserWithHttpInfo(FaxLineAddUserReq } /** * Get Available Fax Line Area Codes. - * Returns a response with the area codes available for a given state/province and city. - * @param country Filter area codes by country. (required) - * @param state Filter area codes by state. (optional) - * @param province Filter area codes by province. (optional) - * @param city Filter area codes by city. (optional) + * Returns a list of available area codes for a given state/province and city + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return FaxLineAreaCodeGetResponse * @throws ApiException if fails to make API call * @http.response.details @@ -198,11 +198,11 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St /** * Get Available Fax Line Area Codes. - * Returns a response with the area codes available for a given state/province and city. - * @param country Filter area codes by country. (required) - * @param state Filter area codes by state. (optional) - * @param province Filter area codes by province. (optional) - * @param city Filter area codes by city. (optional) + * Returns a list of available area codes for a given state/province and city + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return ApiResponse<FaxLineAreaCodeGetResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -252,7 +252,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St } /** * Purchase Fax Line. - * Purchases a new Fax Line. + * Purchases a new Fax Line * @param faxLineCreateRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -270,7 +270,7 @@ public FaxLineResponse faxLineCreate(FaxLineCreateRequest faxLineCreateRequest) /** * Purchase Fax Line. - * Purchases a new Fax Line. + * Purchases a new Fax Line * @param faxLineCreateRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call @@ -373,7 +373,7 @@ public ApiResponse faxLineDeleteWithHttpInfo(FaxLineDeleteRequest faxLineD /** * Get Fax Line. * Returns the properties and settings of a Fax Line. - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return FaxLineResponse * @throws ApiException if fails to make API call * @http.response.details @@ -391,7 +391,7 @@ public FaxLineResponse faxLineGet(String number) throws ApiException { /** * Get Fax Line. * Returns the properties and settings of a Fax Line. - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -440,9 +440,9 @@ public ApiResponse faxLineGetWithHttpInfo(String number) throws * List Fax Lines. * Returns the properties and settings of multiple Fax Lines. * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return FaxLineListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -546,9 +546,9 @@ public ApiResponse faxLineListWithHttpInfo(String accountId * List Fax Lines. * Returns the properties and settings of multiple Fax Lines. * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return ApiResponse<FaxLineListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -599,7 +599,7 @@ public ApiResponse faxLineListWithHttpInfo(String accountId } /** * Remove Fax Line Access. - * Removes a user's access to the specified Fax Line. + * Removes a user's access to the specified Fax Line * @param faxLineRemoveUserRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -617,7 +617,7 @@ public FaxLineResponse faxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU /** * Remove Fax Line Access. - * Removes a user's access to the specified Fax Line. + * Removes a user's access to the specified Fax Line * @param faxLineRemoveUserRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java index 99f972a27..a4d24fbea 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java @@ -73,7 +73,7 @@ public FaxLineAddUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java index 7d23eac13..c05bde435 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java @@ -45,7 +45,7 @@ public class FaxLineCreateRequest { private Integer areaCode; /** - * Country + * Country of the area code */ public enum CountryEnum { CA("CA"), @@ -114,7 +114,7 @@ public FaxLineCreateRequest areaCode(Integer areaCode) { } /** - * Area code + * Area code of the new Fax Line * @return areaCode */ @jakarta.annotation.Nonnull @@ -139,7 +139,7 @@ public FaxLineCreateRequest country(CountryEnum country) { } /** - * Country + * Country of the area code * @return country */ @jakarta.annotation.Nonnull @@ -164,7 +164,7 @@ public FaxLineCreateRequest city(String city) { } /** - * City + * City of the area code * @return city */ @jakarta.annotation.Nullable @@ -189,7 +189,7 @@ public FaxLineCreateRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the account that will be assigned this new Fax Line * @return accountId */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java index c7876dd3f..fb2e7beb5 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java @@ -65,7 +65,7 @@ public FaxLineDeleteRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java index 747853a52..8467a4004 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java @@ -73,7 +73,7 @@ public FaxLineRemoveUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull @@ -98,7 +98,7 @@ public FaxLineRemoveUserRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the user to remove access * @return accountId */ @jakarta.annotation.Nullable @@ -123,7 +123,7 @@ public FaxLineRemoveUserRequest emailAddress(String emailAddress) { } /** - * Email address + * Email address of the user to remove access * @return emailAddress */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java index bb4a6e8a1..1830b7e87 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java @@ -100,7 +100,7 @@ public FaxSendRequest recipient(String recipient) { } /** - * Fax Send To Recipient + * Recipient of the fax Can be a phone number in E.164 format or email address * @return recipient */ @jakarta.annotation.Nonnull @@ -158,7 +158,7 @@ public FaxSendRequest addFilesItem(File filesItem) { } /** - * Fax File to Send + * Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. * @return files */ @jakarta.annotation.Nullable @@ -191,7 +191,7 @@ public FaxSendRequest addFileUrlsItem(String fileUrlsItem) { } /** - * Fax File URL to Send + * Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. * @return fileUrls */ @jakarta.annotation.Nullable @@ -241,7 +241,7 @@ public FaxSendRequest coverPageTo(String coverPageTo) { } /** - * Fax Cover Page for Recipient + * Fax cover page recipient information * @return coverPageTo */ @jakarta.annotation.Nullable @@ -266,7 +266,7 @@ public FaxSendRequest coverPageFrom(String coverPageFrom) { } /** - * Fax Cover Page for Sender + * Fax cover page sender information * @return coverPageFrom */ @jakarta.annotation.Nullable diff --git a/sdks/node/api/faxApi.ts b/sdks/node/api/faxApi.ts index fdb7f9e9f..26e224280 100644 --- a/sdks/node/api/faxApi.ts +++ b/sdks/node/api/faxApi.ts @@ -119,7 +119,7 @@ export class FaxApi { } /** - * Deletes the specified Fax from the system. + * Deletes the specified Fax from the system * @summary Delete Fax * @param faxId Fax ID * @param options @@ -220,7 +220,7 @@ export class FaxApi { }); } /** - * Downloads fax files + * Downloads files associated with a Fax * @summary Download Fax Files * @param faxId Fax ID * @param options @@ -337,7 +337,7 @@ export class FaxApi { }); } /** - * Returns information about fax + * Returns information about a Fax * @summary Get Fax * @param faxId Fax ID * @param options @@ -454,10 +454,10 @@ export class FaxApi { }); } /** - * Returns properties of multiple faxes + * Returns properties of multiple Faxes * @summary Lists Faxes - * @param page Page - * @param pageSize Page size + * @param page Which page number of the Fax List to return. Defaults to `1`. + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. * @param options */ public async faxList( @@ -575,7 +575,7 @@ export class FaxApi { }); } /** - * Action to prepare and send a fax + * Creates and sends a new Fax with the submitted file(s) * @summary Send Fax * @param faxSendRequest * @param options diff --git a/sdks/node/api/faxLineApi.ts b/sdks/node/api/faxLineApi.ts index e9ca6c40d..24510ee88 100644 --- a/sdks/node/api/faxLineApi.ts +++ b/sdks/node/api/faxLineApi.ts @@ -261,12 +261,12 @@ export class FaxLineApi { }); } /** - * Returns a response with the area codes available for a given state/province and city. + * Returns a list of available area codes for a given state/province and city * @summary Get Available Fax Line Area Codes - * @param country Filter area codes by country. - * @param state Filter area codes by state. - * @param province Filter area codes by province. - * @param city Filter area codes by city. + * @param country Filter area codes by country + * @param state Filter area codes by state + * @param province Filter area codes by province + * @param city Filter area codes by city * @param options */ public async faxLineAreaCodeGet( @@ -473,7 +473,7 @@ export class FaxLineApi { }); } /** - * Purchases a new Fax Line. + * Purchases a new Fax Line * @summary Purchase Fax Line * @param faxLineCreateRequest * @param options @@ -735,7 +735,7 @@ export class FaxLineApi { /** * Returns the properties and settings of a Fax Line. * @summary Get Fax Line - * @param number The Fax Line number. + * @param number The Fax Line number * @param options */ public async faxLineGet( @@ -855,9 +855,9 @@ export class FaxLineApi { * Returns the properties and settings of multiple Fax Lines. * @summary List Fax Lines * @param accountId Account ID - * @param page Page - * @param pageSize Page size - * @param showTeamLines Show team lines + * @param page Which page number of the Fax Line List to return. Defaults to `1`. + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. + * @param showTeamLines Include Fax Lines belonging to team members in the list * @param options */ public async faxLineList( @@ -993,7 +993,7 @@ export class FaxLineApi { }); } /** - * Removes a user\'s access to the specified Fax Line. + * Removes a user\'s access to the specified Fax Line * @summary Remove Fax Line Access * @param faxLineRemoveUserRequest * @param options diff --git a/sdks/node/docs/api/FaxApi.md b/sdks/node/docs/api/FaxApi.md index 775241da2..6a67c3316 100644 --- a/sdks/node/docs/api/FaxApi.md +++ b/sdks/node/docs/api/FaxApi.md @@ -19,7 +19,7 @@ faxDelete(faxId: string) Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### TypeScript Example @@ -90,7 +90,7 @@ faxFiles(faxId: string): Buffer Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### TypeScript Example @@ -169,7 +169,7 @@ faxGet(faxId: string): FaxGetResponse Get Fax -Returns information about fax +Returns information about a Fax ### TypeScript Example @@ -246,7 +246,7 @@ faxList(page: number, pageSize: number): FaxListResponse Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### TypeScript Example @@ -298,8 +298,8 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **number**| Page | [optional] [default to 1] | -| **pageSize** | **number**| Page size | [optional] [default to 20] | +| **page** | **number**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **number**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -326,7 +326,7 @@ faxSend(faxSendRequest: FaxSendRequest): FaxGetResponse Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### TypeScript Example diff --git a/sdks/node/docs/api/FaxLineApi.md b/sdks/node/docs/api/FaxLineApi.md index ab90dd93e..dc59add61 100644 --- a/sdks/node/docs/api/FaxLineApi.md +++ b/sdks/node/docs/api/FaxLineApi.md @@ -104,7 +104,7 @@ faxLineAreaCodeGet(country: 'CA' | 'US' | 'UK', state: 'AK' | 'AL' | 'AR' | 'AZ' Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### TypeScript Example @@ -150,10 +150,10 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **country** | **'CA' | 'US' | 'UK'**| Filter area codes by country. | | -| **state** | **'AK' | 'AL' | 'AR' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MI' | 'MN' | 'MO' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY'**| Filter area codes by state. | [optional] | -| **province** | **'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT'**| Filter area codes by province. | [optional] | -| **city** | **string**| Filter area codes by city. | [optional] | +| **country** | **'CA' | 'US' | 'UK'**| Filter area codes by country | | +| **state** | **'AK' | 'AL' | 'AR' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MI' | 'MN' | 'MO' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY'**| Filter area codes by state | [optional] | +| **province** | **'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT'**| Filter area codes by province | [optional] | +| **city** | **string**| Filter area codes by city | [optional] | ### Return type @@ -180,7 +180,7 @@ faxLineCreate(faxLineCreateRequest: FaxLineCreateRequest): FaxLineResponse Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### TypeScript Example @@ -388,7 +388,7 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **number** | **string**| The Fax Line number. | | +| **number** | **string**| The Fax Line number | | ### Return type @@ -462,9 +462,9 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **accountId** | **string**| Account ID | [optional] | -| **page** | **number**| Page | [optional] [default to 1] | -| **pageSize** | **number**| Page size | [optional] [default to 20] | -| **showTeamLines** | **boolean**| Show team lines | [optional] | +| **page** | **number**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **number**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **showTeamLines** | **boolean**| Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -491,7 +491,7 @@ faxLineRemoveUser(faxLineRemoveUserRequest: FaxLineRemoveUserRequest): FaxLineRe Remove Fax Line Access -Removes a user\'s access to the specified Fax Line. +Removes a user\'s access to the specified Fax Line ### TypeScript Example diff --git a/sdks/node/docs/model/FaxLineAddUserRequest.md b/sdks/node/docs/model/FaxLineAddUserRequest.md index df23c2cdb..0b687c0d8 100644 --- a/sdks/node/docs/model/FaxLineAddUserRequest.md +++ b/sdks/node/docs/model/FaxLineAddUserRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | The Fax Line number | | | `accountId` | ```string``` | Account ID | | | `emailAddress` | ```string``` | Email address | | diff --git a/sdks/node/docs/model/FaxLineCreateRequest.md b/sdks/node/docs/model/FaxLineCreateRequest.md index ae70b5cb9..6087b8973 100644 --- a/sdks/node/docs/model/FaxLineCreateRequest.md +++ b/sdks/node/docs/model/FaxLineCreateRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `areaCode`*_required_ | ```number``` | Area code | | -| `country`*_required_ | ```string``` | Country | | -| `city` | ```string``` | City | | -| `accountId` | ```string``` | Account ID | | +| `areaCode`*_required_ | ```number``` | Area code of the new Fax Line | | +| `country`*_required_ | ```string``` | Country of the area code | | +| `city` | ```string``` | City of the area code | | +| `accountId` | ```string``` | Account ID of the account that will be assigned this new Fax Line | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxLineDeleteRequest.md b/sdks/node/docs/model/FaxLineDeleteRequest.md index a2112ed33..fed4ee118 100644 --- a/sdks/node/docs/model/FaxLineDeleteRequest.md +++ b/sdks/node/docs/model/FaxLineDeleteRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | The Fax Line number | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxLineRemoveUserRequest.md b/sdks/node/docs/model/FaxLineRemoveUserRequest.md index e161ecf38..9ae81a65e 100644 --- a/sdks/node/docs/model/FaxLineRemoveUserRequest.md +++ b/sdks/node/docs/model/FaxLineRemoveUserRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | -| `accountId` | ```string``` | Account ID | | -| `emailAddress` | ```string``` | Email address | | +| `number`*_required_ | ```string``` | The Fax Line number | | +| `accountId` | ```string``` | Account ID of the user to remove access | | +| `emailAddress` | ```string``` | Email address of the user to remove access | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxSendRequest.md b/sdks/node/docs/model/FaxSendRequest.md index 72ebb6fb0..9df85d9d2 100644 --- a/sdks/node/docs/model/FaxSendRequest.md +++ b/sdks/node/docs/model/FaxSendRequest.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```string``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```string``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```string``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```Array``` | Fax File to Send | | -| `fileUrls` | ```Array``` | Fax File URL to Send | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `testMode` | ```boolean``` | API Test Mode Setting | [default to false] | -| `coverPageTo` | ```string``` | Fax Cover Page for Recipient | | -| `coverPageFrom` | ```string``` | Fax Cover Page for Sender | | +| `coverPageTo` | ```string``` | Fax cover page recipient information | | +| `coverPageFrom` | ```string``` | Fax cover page sender information | | | `coverPageMessage` | ```string``` | Fax Cover Page Message | | | `title` | ```string``` | Fax Title | | diff --git a/sdks/node/model/faxLineAddUserRequest.ts b/sdks/node/model/faxLineAddUserRequest.ts index 95b75de1b..5f890f7dd 100644 --- a/sdks/node/model/faxLineAddUserRequest.ts +++ b/sdks/node/model/faxLineAddUserRequest.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineAddUserRequest { /** - * The Fax Line number. + * The Fax Line number */ "number": string; /** diff --git a/sdks/node/model/faxLineCreateRequest.ts b/sdks/node/model/faxLineCreateRequest.ts index 3a67d60e4..764da8214 100644 --- a/sdks/node/model/faxLineCreateRequest.ts +++ b/sdks/node/model/faxLineCreateRequest.ts @@ -26,19 +26,19 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineCreateRequest { /** - * Area code + * Area code of the new Fax Line */ "areaCode": number; /** - * Country + * Country of the area code */ "country": FaxLineCreateRequest.CountryEnum; /** - * City + * City of the area code */ "city"?: string; /** - * Account ID + * Account ID of the account that will be assigned this new Fax Line */ "accountId"?: string; diff --git a/sdks/node/model/faxLineDeleteRequest.ts b/sdks/node/model/faxLineDeleteRequest.ts index 26d8798c4..1cb2e63dc 100644 --- a/sdks/node/model/faxLineDeleteRequest.ts +++ b/sdks/node/model/faxLineDeleteRequest.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineDeleteRequest { /** - * The Fax Line number. + * The Fax Line number */ "number": string; diff --git a/sdks/node/model/faxLineRemoveUserRequest.ts b/sdks/node/model/faxLineRemoveUserRequest.ts index 02f921c6a..26e8b4e6b 100644 --- a/sdks/node/model/faxLineRemoveUserRequest.ts +++ b/sdks/node/model/faxLineRemoveUserRequest.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineRemoveUserRequest { /** - * The Fax Line number. + * The Fax Line number */ "number": string; /** - * Account ID + * Account ID of the user to remove access */ "accountId"?: string; /** - * Email address + * Email address of the user to remove access */ "emailAddress"?: string; diff --git a/sdks/node/model/faxSendRequest.ts b/sdks/node/model/faxSendRequest.ts index 11ee71ef4..fcd45d645 100644 --- a/sdks/node/model/faxSendRequest.ts +++ b/sdks/node/model/faxSendRequest.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; export class FaxSendRequest { /** - * Fax Send To Recipient + * Recipient of the fax Can be a phone number in E.164 format or email address */ "recipient": string; /** @@ -34,11 +34,11 @@ export class FaxSendRequest { */ "sender"?: string; /** - * Fax File to Send + * Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. */ "files"?: Array; /** - * Fax File URL to Send + * Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. */ "fileUrls"?: Array; /** @@ -46,11 +46,11 @@ export class FaxSendRequest { */ "testMode"?: boolean = false; /** - * Fax Cover Page for Recipient + * Fax cover page recipient information */ "coverPageTo"?: string; /** - * Fax Cover Page for Sender + * Fax cover page sender information */ "coverPageFrom"?: string; /** diff --git a/sdks/php/README.md b/sdks/php/README.md index 946c74e1f..d433ddf5c 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -73,32 +73,7 @@ Please follow the [installation procedure](#installation--usage) and then run th ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountCreateRequest(); -$data->setEmailAddress("newuser@dropboxsign.com"); - -try { - $result = $accountApi->accountCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__accountCreate_PHP_CODE ``` You may also instantiate objects by calling the class' `::init()` method: diff --git a/sdks/php/docs/Api/AccountApi.md b/sdks/php/docs/Api/AccountApi.md index 9c8e8c9f0..c5c923f53 100644 --- a/sdks/php/docs/Api/AccountApi.md +++ b/sdks/php/docs/Api/AccountApi.md @@ -22,32 +22,7 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountCreateRequest(); -$data->setEmailAddress("newuser@dropboxsign.com"); - -try { - $result = $accountApi->accountCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__accountCreate_PHP_CODE ``` ### Parameters @@ -85,37 +60,15 @@ Returns the properties and settings of your Account. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -try { - $result = $accountApi->accountGet(null, 'jack@example.com'); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__accountGet_PHP_CODE ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **account_id** | **string**| `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. | [optional] | -| **email_address** | **string**| `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. | [optional] | +| **account_id** | **string**| `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. | [optional] | +| **email_address** | **string**| `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. | [optional] | ### Return type @@ -146,32 +99,7 @@ Updates the properties and settings of your Account. Currently only allows for u ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountUpdateRequest(); -$data->setCallbackUrl("https://www.example.com/callback"); - -try { - $result = $accountApi->accountUpdate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__accountUpdate_PHP_CODE ``` ### Parameters @@ -209,32 +137,7 @@ Verifies whether an Dropbox Sign Account exists for the given email address. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountVerifyRequest(); -$data->setEmailAddress("some_user@dropboxsign.com"); - -try { - $result = $accountApi->accountVerify($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__accountVerify_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Api/ApiAppApi.md b/sdks/php/docs/Api/ApiAppApi.md index 45604a821..9b9e8978b 100644 --- a/sdks/php/docs/Api/ApiAppApi.md +++ b/sdks/php/docs/Api/ApiAppApi.md @@ -23,49 +23,7 @@ Creates a new API App. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$oauth = new Dropbox\Sign\Model\SubOAuth(); -$oauth->setCallbackUrl("https://example.com/oauth") - ->setScopes([ - Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, - Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, - ]); - -$whiteLabelingOptions = new Dropbox\Sign\Model\SubWhiteLabelingOptions(); -$whiteLabelingOptions->setPrimaryButtonColor("#00b3e6") - ->setPrimaryButtonTextColor("#ffffff"); - -$customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); - -$data = new Dropbox\Sign\Model\ApiAppCreateRequest(); -$data->setName("My Production App") - ->setDomains(["example.com"]) - ->setOauth($oauth) - ->setWhiteLabelingOptions($whiteLabelingOptions) - ->setCustomLogoFile($customLogoFile); - -try { - $result = $apiAppApi->apiAppCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__apiAppCreate_PHP_CODE ``` ### Parameters @@ -103,30 +61,7 @@ Deletes an API App. Can only be invoked for apps you own. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -try { - $apiAppApi->apiAppDelete($clientId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__apiAppDelete_PHP_CODE ``` ### Parameters @@ -164,31 +99,7 @@ Returns an object with information about an API App. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -try { - $result = $apiAppApi->apiAppGet($clientId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__apiAppGet_PHP_CODE ``` ### Parameters @@ -226,40 +137,15 @@ Returns a list of API Apps that are accessible by you. If you are on a team with ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$page = 1; -$pageSize = 2; - -try { - $result = $apiAppApi->apiAppList($page, $pageSize); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__apiAppList_PHP_CODE ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **int**| Which page number of the API App List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **page** | **int**| Which page number of the API App List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -290,43 +176,7 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$whiteLabelingOptions = new Dropbox\Sign\Model\SubWhiteLabelingOptions(); -$whiteLabelingOptions->setPrimaryButtonColor("#00b3e6") - ->setPrimaryButtonTextColor("#ffffff"); - -$customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); - -$data = new Dropbox\Sign\Model\ApiAppUpdateRequest(); -$data->setName("New Name") - ->setCallbackUrl("https://example.com/dropboxsign") - ->setWhiteLabelingOptions($whiteLabelingOptions) - ->setCustomLogoFile($customLogoFile); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -try { - $result = $apiAppApi->apiAppUpdate($clientId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__apiAppUpdate_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Api/BulkSendJobApi.md b/sdks/php/docs/Api/BulkSendJobApi.md index ede4f3415..2fa0513a7 100644 --- a/sdks/php/docs/Api/BulkSendJobApi.md +++ b/sdks/php/docs/Api/BulkSendJobApi.md @@ -20,31 +20,7 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config); - -$bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - -try { - $result = $bulkSendJobApi->bulkSendJobGet($bulkSendJobId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__bulkSendJobGet_PHP_CODE ``` ### Parameters @@ -52,8 +28,8 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **bulk_send_job_id** | **string**| The id of the BulkSendJob to retrieve. | | -| **page** | **int**| Which page number of the BulkSendJob list to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional] [default to 20] | +| **page** | **int**| Which page number of the BulkSendJob list to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional] [default to 20] | ### Return type @@ -84,40 +60,15 @@ Returns a list of BulkSendJob that you can access. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config); - -$page = 1; -$pageSize = 20; - -try { - $result = $bulkSendJobApi->bulkSendJobList($page, $pageSize); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__bulkSendJobList_PHP_CODE ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **int**| Which page number of the BulkSendJob List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional] [default to 20] | +| **page** | **int**| Which page number of the BulkSendJob List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional] [default to 20] | ### Return type diff --git a/sdks/php/docs/Api/EmbeddedApi.md b/sdks/php/docs/Api/EmbeddedApi.md index 8b1acfbc4..768017fd0 100644 --- a/sdks/php/docs/Api/EmbeddedApi.md +++ b/sdks/php/docs/Api/EmbeddedApi.md @@ -20,35 +20,7 @@ Retrieves an embedded object containing a template url that can be opened in an ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$embeddedApi = new Dropbox\Sign\Api\EmbeddedApi($config); - -$data = new Dropbox\Sign\Model\EmbeddedEditUrlRequest(); -$data->setCcRoles([""]) - ->setMergeFields([]); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $embeddedApi->embeddedEditUrl($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__embeddedEditUrl_PHP_CODE ``` ### Parameters @@ -87,31 +59,7 @@ Retrieves an embedded object containing a signature url that can be opened in an ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$embeddedApi = new Dropbox\Sign\Api\EmbeddedApi($config); - -$signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - -try { - $result = $embeddedApi->embeddedSignUrl($signatureId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__embeddedSignUrl_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Api/FaxApi.md b/sdks/php/docs/Api/FaxApi.md index 78e411118..06a4b0d44 100644 --- a/sdks/php/docs/Api/FaxApi.md +++ b/sdks/php/docs/Api/FaxApi.md @@ -18,30 +18,12 @@ faxDelete($fax_id) ``` Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -try { - $faxApi->faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxDelete_PHP_CODE ``` ### Parameters @@ -74,33 +56,12 @@ faxFiles($fax_id): \SplFileObject ``` Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $faxApi->faxFiles($faxId); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxFiles_PHP_CODE ``` ### Parameters @@ -133,33 +94,12 @@ faxGet($fax_id): \Dropbox\Sign\Model\FaxGetResponse ``` Get Fax -Returns information about fax +Returns information about a Fax ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $faxApi->faxGet($faxId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxGet_PHP_CODE ``` ### Parameters @@ -192,42 +132,20 @@ faxList($page, $page_size): \Dropbox\Sign\Model\FaxListResponse ``` Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$page = 1; -$pageSize = 2; - -try { - $result = $faxApi->faxList($page, $pageSize); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxList_PHP_CODE ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **int**| Page | [optional] [default to 1] | -| **page_size** | **int**| Page size | [optional] [default to 20] | +| **page** | **int**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -253,41 +171,12 @@ faxSend($fax_send_request): \Dropbox\Sign\Model\FaxGetResponse ``` Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$data = new Dropbox\Sign\Model\FaxSendRequest(); -$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setTestMode(true) - ->setRecipient("16690000001") - ->setSender("16690000000") - ->setCoverPageTo("Jill Fax") - ->setCoverPageMessage("I'm sending you a fax!") - ->setCoverPageFrom("Faxer Faxerson") - ->setTitle("This is what the fax is about!"); - -try { - $result = $faxApi->faxSend($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxSend_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Api/FaxLineApi.md b/sdks/php/docs/Api/FaxLineApi.md index 44789fc33..82f1494ec 100644 --- a/sdks/php/docs/Api/FaxLineApi.md +++ b/sdks/php/docs/Api/FaxLineApi.md @@ -25,30 +25,7 @@ Grants a user access to the specified Fax Line. ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineAddUserRequest(); -$data->setNumber("[FAX_NUMBER]") - ->setEmailAddress("member@dropboxsign.com"); - -try { - $result = $faxLineApi->faxLineAddUser($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxLineAddUser_PHP_CODE ``` ### Parameters @@ -81,41 +58,22 @@ faxLineAreaCodeGet($country, $state, $province, $city): \Dropbox\Sign\Model\FaxL ``` Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -try { - $result = $faxLineApi->faxLineAreaCodeGet("US", "CA"); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxLineAreaCodeGet_PHP_CODE ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **country** | **string**| Filter area codes by country. | | -| **state** | **string**| Filter area codes by state. | [optional] | -| **province** | **string**| Filter area codes by province. | [optional] | -| **city** | **string**| Filter area codes by city. | [optional] | +| **country** | **string**| Filter area codes by country | | +| **state** | **string**| Filter area codes by state | [optional] | +| **province** | **string**| Filter area codes by province | [optional] | +| **city** | **string**| Filter area codes by city | [optional] | ### Return type @@ -141,35 +99,12 @@ faxLineCreate($fax_line_create_request): \Dropbox\Sign\Model\FaxLineResponse ``` Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineCreateRequest(); -$data->setAreaCode(209) - ->setCountry("US"); - -try { - $result = $faxLineApi->faxLineCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxLineCreate_PHP_CODE ``` ### Parameters @@ -207,28 +142,7 @@ Deletes the specified Fax Line from the subscription. ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineDeleteRequest(); -$data->setNumber("[FAX_NUMBER]"); - -try { - $faxLineApi->faxLineDelete($data); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxLineDelete_PHP_CODE ``` ### Parameters @@ -266,33 +180,14 @@ Returns the properties and settings of a Fax Line. ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -try { - $result = $faxLineApi->faxLineGet("[FAX_NUMBER]"); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxLineGet_PHP_CODE ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **number** | **string**| The Fax Line number. | | +| **number** | **string**| The Fax Line number | | ### Return type @@ -323,26 +218,7 @@ Returns the properties and settings of multiple Fax Lines. ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -try { - $result = $faxLineApi->faxLineList(); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxLineList_PHP_CODE ``` ### Parameters @@ -350,9 +226,9 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **account_id** | **string**| Account ID | [optional] | -| **page** | **int**| Page | [optional] [default to 1] | -| **page_size** | **int**| Page size | [optional] [default to 20] | -| **show_team_lines** | **bool**| Show team lines | [optional] | +| **page** | **int**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **show_team_lines** | **bool**| Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -378,35 +254,12 @@ faxLineRemoveUser($fax_line_remove_user_request): \Dropbox\Sign\Model\FaxLineRes ``` Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example ```php -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineRemoveUserRequest(); -$data->setNumber("[FAX_NUMBER]") - ->setEmailAddress("member@dropboxsign.com"); - -try { - $result = $faxLineApi->faxLineRemoveUser($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__faxLineRemoveUser_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Api/OAuthApi.md b/sdks/php/docs/Api/OAuthApi.md index 854b4b7a0..451acd420 100644 --- a/sdks/php/docs/Api/OAuthApi.md +++ b/sdks/php/docs/Api/OAuthApi.md @@ -20,29 +20,7 @@ Once you have retrieved the code from the user callback, you will need to exchan ### Example ```php -setState("900e06e2") - ->setCode("1b0d28d90c86c141") - ->setClientId("cc91c61d00f8bb2ece1428035716b") - ->setClientSecret("1d14434088507ffa390e6f5528465"); - -try { - $result = $oauthApi->oauthTokenGenerate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__oauthTokenGenerate_PHP_CODE ``` ### Parameters @@ -80,26 +58,7 @@ Access tokens are only valid for a given period of time (typically one hour) for ### Example ```php -setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); - -try { - $result = $oauthApi->oauthTokenRefresh($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__oauthTokenRefresh_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Api/ReportApi.md b/sdks/php/docs/Api/ReportApi.md index 285a20e83..2c3511cdf 100644 --- a/sdks/php/docs/Api/ReportApi.md +++ b/sdks/php/docs/Api/ReportApi.md @@ -19,34 +19,7 @@ Request the creation of one or more report(s). When the report(s) have been gen ### Example ```php -setUsername("YOUR_API_KEY"); - -$reportApi = new Dropbox\Sign\Api\ReportApi($config); - -$data = new Dropbox\Sign\Model\ReportCreateRequest(); -$data->setStartDate("09/01/2020") - ->setEndDate("09/01/2020") - ->setReportType([ - Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_USER_ACTIVITY, - Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_DOCUMENT_STATUS, - ]); - -try { - $result = $reportApi->reportCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__reportCreate_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Api/SignatureRequestApi.md b/sdks/php/docs/Api/SignatureRequestApi.md index aa4979035..7edf79879 100644 --- a/sdks/php/docs/Api/SignatureRequestApi.md +++ b/sdks/php/docs/Api/SignatureRequestApi.md @@ -34,67 +34,7 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### Example ```php -setUsername("YOUR_API_KEY"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signerList1Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList1Signer->setRole("Client") - ->setName("George") - ->setEmailAddress("george@example.com") - ->setPin("d79a3td"); - -$signerList1CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList1CustomFields->setName("company") - ->setValue("ABC Corp"); - -$signerList1 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList1->setSigners([$signerList1Signer]) - ->setCustomFields([$signerList1CustomFields]); - -$signerList2Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList2Signer->setRole("Client") - ->setName("Mary") - ->setEmailAddress("mary@example.com") - ->setPin("gd9as5b"); - -$signerList2CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList2CustomFields->setName("company") - ->setValue("123 LLC"); - -$signerList2 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList2->setSigners([$signerList2Signer]) - ->setCustomFields([$signerList2CustomFields]); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$data = new Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); -$data->setClientId("1a659d9ad95bccd307ecad78d72192f8") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSignerList([$signerList1, $signerList2]) - ->setCcs([$cc1]) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestBulkCreateEmbeddedWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestBulkCreateEmbeddedWithTemplate_PHP_CODE ``` ### Parameters @@ -132,69 +72,7 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signerList1Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList1Signer->setRole("Client") - ->setName("George") - ->setEmailAddress("george@example.com") - ->setPin("d79a3td"); - -$signerList1CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList1CustomFields->setName("company") - ->setValue("ABC Corp"); - -$signerList1 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList1->setSigners([$signerList1Signer]) - ->setCustomFields([$signerList1CustomFields]); - -$signerList2Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList2Signer->setRole("Client") - ->setName("Mary") - ->setEmailAddress("mary@example.com") - ->setPin("gd9as5b"); - -$signerList2CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList2CustomFields->setName("company") - ->setValue("123 LLC"); - -$signerList2 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList2->setSigners([$signerList2Signer]) - ->setCustomFields([$signerList2CustomFields]); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$data = new Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSignerList([$signerList1, $signerList2]) - ->setCcs([$cc1]) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestBulkSendWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestBulkSendWithTemplate_PHP_CODE ``` ### Parameters @@ -232,30 +110,7 @@ Cancels an incomplete signature request. This action is **not reversible**. The ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $signatureRequestApi->signatureRequestCancel($signatureRequestId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestCancel_PHP_CODE ``` ### Parameters @@ -293,60 +148,7 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(true) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTitle("NDA with Acme Co.") - ->setSubject("The NDA we talked about") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestCreateEmbedded($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestCreateEmbedded_PHP_CODE ``` ### Parameters @@ -384,50 +186,7 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestCreateEmbeddedWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestCreateEmbeddedWithTemplate_PHP_CODE ``` ### Parameters @@ -465,32 +224,7 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; -$fileType = "pdf"; - -try { - $result = $signatureRequestApi->signatureRequestFiles($signatureRequestId, $fileType); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestFiles_PHP_CODE ``` ### Parameters @@ -498,7 +232,7 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **signature_request_id** | **string**| The id of the SignatureRequest to retrieve. | | -| **file_type** | **string**| Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] [default to 'pdf'] | +| **file_type** | **string**| Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] [default to 'pdf'] | ### Return type @@ -529,31 +263,7 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $signatureRequestApi->signatureRequestFilesAsDataUri($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestFilesAsDataUri_PHP_CODE ``` ### Parameters @@ -591,31 +301,7 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $signatureRequestApi->signatureRequestFilesAsFileUrl($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestFilesAsFileUrl_PHP_CODE ``` ### Parameters @@ -623,7 +309,7 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **signature_request_id** | **string**| The id of the SignatureRequest to retrieve. | | -| **force_download** | **int**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] | +| **force_download** | **int**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] | ### Return type @@ -654,31 +340,7 @@ Returns the status of the SignatureRequest specified by the `signature_request_i ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $signatureRequestApi->signatureRequestGet($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestGet_PHP_CODE ``` ### Parameters @@ -716,41 +378,16 @@ Returns a list of SignatureRequests that you can access. This includes Signature ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$accountId = null; -$page = 1; - -try { - $result = $signatureRequestApi->signatureRequestList($accountId, $page); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestList_PHP_CODE ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **account_id** | **string**| Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] | -| **page** | **int**| Which page number of the SignatureRequest List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **account_id** | **string**| Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] | +| **page** | **int**| Which page number of the SignatureRequest List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | | **query** | **string**| String that includes search terms and/or fields to be used to filter the SignatureRequest objects. | [optional] | ### Return type @@ -782,31 +419,7 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestReleaseHold($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestReleaseHold_PHP_CODE ``` ### Parameters @@ -844,34 +457,7 @@ Sends an email to the signer reminding them to sign the signature request. You c ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$data = new Dropbox\Sign\Model\SignatureRequestRemindRequest(); -$data->setEmailAddress("john@example.com"); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestRemind($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestRemind_PHP_CODE ``` ### Parameters @@ -910,27 +496,7 @@ Removes your access to a completed signature request. This action is **not rever ### Example ```php -setUsername("YOUR_API_KEY"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $signatureRequestApi->signatureRequestRemove($signatureRequestId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestRemove_PHP_CODE ``` ### Parameters @@ -968,67 +534,7 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\SignatureRequestSendRequest(); -$data->setTitle("NDA with Acme Co.") - ->setSubject("The NDA we talked about") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", - ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestSend($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestSend_PHP_CODE ``` ### Parameters @@ -1066,61 +572,7 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$customField1 = new Dropbox\Sign\Model\SubCustomField(); -$customField1->setName("Cost") - ->setValue("$20,000") - ->setEditor("Client") - ->setRequired(true); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setCustomFields([$customField1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestSendWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestSendWithTemplate_PHP_CODE ``` ### Parameters @@ -1158,35 +610,7 @@ Updates the email address and/or the name for a given signer on a signature requ ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$data = new Dropbox\Sign\Model\SignatureRequestUpdateRequest(); -$data->setEmailAddress("john@example.com") - ->setSignatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestUpdate($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestUpdate_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Api/TeamApi.md b/sdks/php/docs/Api/TeamApi.md index 1f46c6b3f..22565853c 100644 --- a/sdks/php/docs/Api/TeamApi.md +++ b/sdks/php/docs/Api/TeamApi.md @@ -28,32 +28,7 @@ Invites a user (specified using the `email_address` parameter) to your Team. If ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamAddMemberRequest(); -$data->setEmailAddress("george@example.com"); - -try { - $result = $teamApi->teamAddMember($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__teamAddMember_PHP_CODE ``` ### Parameters @@ -92,32 +67,7 @@ Creates a new Team and makes you a member. You must not currently belong to a Te ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamCreateRequest(); -$data->setName("New Team Name"); - -try { - $result = $teamApi->teamCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__teamCreate_PHP_CODE ``` ### Parameters @@ -155,28 +105,7 @@ Deletes your Team. Can only be invoked when you have a Team with only one member ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -try { - $teamApi->teamDelete(); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__teamDelete_PHP_CODE ``` ### Parameters @@ -212,29 +141,7 @@ Returns information about your Team as well as a list of its members. If you do ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -try { - $result = $teamApi->teamGet(); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__teamGet_PHP_CODE ``` ### Parameters @@ -270,29 +177,7 @@ Provides information about a team. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -try { - $result = $teamApi->teamInfo(); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__teamInfo_PHP_CODE ``` ### Parameters @@ -330,31 +215,7 @@ Provides a list of team invites (and their roles). ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$emailAddress = "user@dropboxsign.com"; - -try { - $result = $teamApi->teamInvites($emailAddress); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__teamInvites_PHP_CODE ``` ### Parameters @@ -392,31 +253,7 @@ Provides a paginated list of members (and their roles) that belong to a given te ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -try { - $result = $teamApi->teamMembers($teamId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__teamMembers_PHP_CODE ``` ### Parameters @@ -424,8 +261,8 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **team_id** | **string**| The id of the team that a member list is being requested from. | | -| **page** | **int**| Which page number of the team member list to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **page** | **int**| Which page number of the team member list to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -456,33 +293,7 @@ Removes the provided user Account from your Team. If the Account had an outstand ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamRemoveMemberRequest(); -$data->setEmailAddress("teammate@dropboxsign.com") - ->setNewOwnerEmailAddress("new_teammate@dropboxsign.com"); - -try { - $result = $teamApi->teamRemoveMember($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__teamRemoveMember_PHP_CODE ``` ### Parameters @@ -520,31 +331,7 @@ Provides a paginated list of sub teams that belong to a given team. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -try { - $result = $teamApi->teamSubTeams($teamId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__teamSubTeams_PHP_CODE ``` ### Parameters @@ -552,8 +339,8 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **team_id** | **string**| The id of the parent Team. | | -| **page** | **int**| Which page number of the SubTeam List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **page** | **int**| Which page number of the SubTeam List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -584,32 +371,7 @@ Updates the name of your Team. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamUpdateRequest(); -$data->setName("New Team Name"); - -try { - $result = $teamApi->teamUpdate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__teamUpdate_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Api/TemplateApi.md b/sdks/php/docs/Api/TemplateApi.md index 5381a8290..99d1c4d4e 100644 --- a/sdks/php/docs/Api/TemplateApi.md +++ b/sdks/php/docs/Api/TemplateApi.md @@ -29,34 +29,7 @@ Gives the specified Account access to the specified Template. The specified Acco ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateAddUserRequest(); -$data->setEmailAddress("george@dropboxsign.com"); - -$templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -try { - $result = $templateApi->templateAddUser($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateAddUser_PHP_CODE ``` ### Parameters @@ -95,60 +68,7 @@ Creates a template that can then be used. ### Example ```php -setUsername('YOUR_API_KEY'); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$role1 = new Dropbox\Sign\Model\SubTemplateRole(); -$role1->setName('Client') - ->setOrder(0); - -$role2 = new Dropbox\Sign\Model\SubTemplateRole(); -$role2->setName('Witness') - ->setOrder(1); - -$mergeField1 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField1->setName('Full Name') - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); - -$mergeField2 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField2->setName('Is Registered?') - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\TemplateCreateRequest(); -$data->setClientId('37dee8d8440c66d54cfa05d92c160882') - ->setFiles([new SplFileObject(__DIR__ . '/example_signature_request.pdf')]) - ->setTitle('Test Template') - ->setSubject('Please sign this document') - ->setMessage('For your approval') - ->setSignerRoles([$role1, $role2]) - ->setCcRoles(['Manager']) - ->setMergeFields([$mergeField1, $mergeField2]) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $templateApi->templateCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo 'Exception when calling Dropbox Sign API: ' - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateCreate_PHP_CODE ``` ### Parameters @@ -186,60 +106,7 @@ The first step in an embedded template workflow. Creates a draft template that c ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$role1 = new Dropbox\Sign\Model\SubTemplateRole(); -$role1->setName("Client") - ->setOrder(0); - -$role2 = new Dropbox\Sign\Model\SubTemplateRole(); -$role2->setName("Witness") - ->setOrder(1); - -$mergeField1 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField1->setName("Full Name") - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); - -$mergeField2 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField2->setName("Is Registered?") - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest(); -$data->setClientId("37dee8d8440c66d54cfa05d92c160882") - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setTitle("Test Template") - ->setSubject("Please sign this document") - ->setMessage("For your approval") - ->setSignerRoles([$role1, $role2]) - ->setCcRoles(["Manager"]) - ->setMergeFields([$mergeField1, $mergeField2]) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $templateApi->templateCreateEmbeddedDraft($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateCreateEmbeddedDraft_PHP_CODE ``` ### Parameters @@ -277,30 +144,7 @@ Completely deletes the template specified from the account. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $templateApi->templateDelete($templateId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateDelete_PHP_CODE ``` ### Parameters @@ -338,32 +182,7 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; -$fileType = "pdf"; - -try { - $result = $templateApi->templateFiles($templateId, $fileType); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateFiles_PHP_CODE ``` ### Parameters @@ -371,7 +190,7 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **template_id** | **string**| The id of the template files to retrieve. | | -| **file_type** | **string**| Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] | +| **file_type** | **string**| Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] | ### Return type @@ -402,31 +221,7 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $templateApi->templateFilesAsDataUri($templateId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateFilesAsDataUri_PHP_CODE ``` ### Parameters @@ -464,31 +259,7 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $templateApi->templateFilesAsFileUrl($templateId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateFilesAsFileUrl_PHP_CODE ``` ### Parameters @@ -496,7 +267,7 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **template_id** | **string**| The id of the template files to retrieve. | | -| **force_download** | **int**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] | +| **force_download** | **int**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] | ### Return type @@ -527,31 +298,7 @@ Returns the Template specified by the `template_id` parameter. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -try { - $result = $templateApi->templateGet($templateId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateGet_PHP_CODE ``` ### Parameters @@ -589,40 +336,16 @@ Returns a list of the Templates that are accessible by you. Take a look at our ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$accountId = "f57db65d3f933b5316d398057a36176831451a35"; - -try { - $result = $templateApi->templateList($accountId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateList_PHP_CODE ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **account_id** | **string**| Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] | -| **page** | **int**| Which page number of the Template List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **account_id** | **string**| Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] | +| **page** | **int**| Which page number of the Template List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | | **query** | **string**| String that includes search terms and/or fields to be used to filter the Template objects. | [optional] | ### Return type @@ -654,34 +377,7 @@ Removes the specified Account's access to the specified Template. ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateRemoveUserRequest(); -$data->setEmailAddress("george@dropboxsign.com"); - -$templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - -try { - $result = $templateApi->templateRemoveUser($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateRemoveUser_PHP_CODE ``` ### Parameters @@ -720,34 +416,7 @@ Overlays a new file with the overlay of an existing template. The new file(s) mu ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateUpdateFilesRequest(); -$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $templateApi->templateUpdateFiles($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__templateUpdateFiles_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Api/UnclaimedDraftApi.md b/sdks/php/docs/Api/UnclaimedDraftApi.md index a2b2f4236..b0f32a1c2 100644 --- a/sdks/php/docs/Api/UnclaimedDraftApi.md +++ b/sdks/php/docs/Api/UnclaimedDraftApi.md @@ -22,67 +22,7 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$signer1 = new Dropbox\Sign\Model\SubUnclaimedDraftSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubUnclaimedDraftSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateRequest(); -$data->setSubject("The NDA we talked about") - ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", - ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $unclaimedDraftApi->unclaimedDraftCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__unclaimedDraftCreate_PHP_CODE ``` ### Parameters @@ -120,35 +60,7 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setRequesterEmailAddress("jack@dropboxsign.com") - ->setTestMode(true); - -try { - $result = $unclaimedDraftApi->unclaimedDraftCreateEmbedded($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__unclaimedDraftCreateEmbedded_PHP_CODE ``` ### Parameters @@ -186,46 +98,7 @@ Creates a new Draft with a previously saved template(s) that can be claimed and ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$signer1 = new Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner(); -$signer1->setRole("Client") - ->setName("George") - ->setEmailAddress("george@example.com"); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@dropboxsign.com"); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["61a832ff0d8423f91d503e76bfbcc750f7417c78"]) - ->setRequesterEmailAddress("jack@dropboxsign.com") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setTestMode(true); - -try { - $result = $unclaimedDraftApi->unclaimedDraftCreateEmbeddedWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__unclaimedDraftCreateEmbeddedWithTemplate_PHP_CODE ``` ### Parameters @@ -263,35 +136,7 @@ Creates a new signature request from an embedded request that can be edited prio ### Example ```php -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$data = new Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - -try { - $result = $unclaimedDraftApi->unclaimedDraftEditAndResend($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} - +REPLACE_ME_WITH_EXAMPLE_FOR__unclaimedDraftEditAndResend_PHP_CODE ``` ### Parameters diff --git a/sdks/php/docs/Model/AccountCreateRequest.md b/sdks/php/docs/Model/AccountCreateRequest.md index 4fb7caf90..d6c2fda2b 100644 --- a/sdks/php/docs/Model/AccountCreateRequest.md +++ b/sdks/php/docs/Model/AccountCreateRequest.md @@ -6,9 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address`*_required_ | ```string``` | The email address which will be associated with the new Account. | | -| `client_id` | ```string``` | Used when creating a new account with OAuth authorization.

See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | | -| `client_secret` | ```string``` | Used when creating a new account with OAuth authorization.

See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | | -| `locale` | ```string``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | +| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address which will be associated with the new Account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Used when creating a new account with OAuth authorization. + +See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_secret` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Used when creating a new account with OAuth authorization. + +See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) REPLACE_ME_WITH_DESCRIPTION_END | | +| `locale` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountCreateResponse.md b/sdks/php/docs/Model/AccountCreateResponse.md index bf38de482..68f31c87a 100644 --- a/sdks/php/docs/Model/AccountCreateResponse.md +++ b/sdks/php/docs/Model/AccountCreateResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account`*_required_ | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | | | -| `oauth_data` | [```\Dropbox\Sign\Model\OAuthTokenResponse```](OAuthTokenResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `account`*_required_ | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `oauth_data` | [```\Dropbox\Sign\Model\OAuthTokenResponse```](OAuthTokenResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountGetResponse.md b/sdks/php/docs/Model/AccountGetResponse.md index e7cecaf5d..0ba684643 100644 --- a/sdks/php/docs/Model/AccountGetResponse.md +++ b/sdks/php/docs/Model/AccountGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account`*_required_ | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `account`*_required_ | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponse.md b/sdks/php/docs/Model/AccountResponse.md index 3121826ba..acefb359a 100644 --- a/sdks/php/docs/Model/AccountResponse.md +++ b/sdks/php/docs/Model/AccountResponse.md @@ -6,16 +6,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The ID of the Account | | -| `email_address` | ```string``` | The email address associated with the Account. | | -| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```\Dropbox\Sign\Model\AccountResponseQuotas```](AccountResponseQuotas.md) | | | -| `callback_url` | ```string``` | The URL that Dropbox Sign events will `POST` to. | | -| `role_code` | ```string``` | The membership role for the team. | | -| `team_id` | ```string``` | The id of the team account belongs to. | | -| `locale` | ```string``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | -| `usage` | [```\Dropbox\Sign\Model\AccountResponseUsage```](AccountResponseUsage.md) | | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The ID of the Account REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address associated with the Account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_locked` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has been locked out of their account by a team admin. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_paid_hs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has a paid Dropbox Sign account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_paid_hf` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has a paid HelloFax account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `quotas` | [```\Dropbox\Sign\Model\AccountResponseQuotas```](AccountResponseQuotas.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL that Dropbox Sign events will `POST` to. REPLACE_ME_WITH_DESCRIPTION_END | | +| `role_code` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The membership role for the team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the team account belongs to. REPLACE_ME_WITH_DESCRIPTION_END | | +| `locale` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. REPLACE_ME_WITH_DESCRIPTION_END | | +| `usage` | [```\Dropbox\Sign\Model\AccountResponseUsage```](AccountResponseUsage.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponseQuotas.md b/sdks/php/docs/Model/AccountResponseQuotas.md index 96399403d..e7b4f28ee 100644 --- a/sdks/php/docs/Model/AccountResponseQuotas.md +++ b/sdks/php/docs/Model/AccountResponseQuotas.md @@ -6,11 +6,11 @@ Details concerning remaining monthly quotas. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `templates_total` | ```int``` | Total API templates allowed. | | -| `templates_left` | ```int``` | API templates remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```int``` | Number of fax pages left | | +| `api_signature_requests_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN API signature requests remaining. REPLACE_ME_WITH_DESCRIPTION_END | | +| `documents_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signature requests remaining. REPLACE_ME_WITH_DESCRIPTION_END | | +| `templates_total` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Total API templates allowed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `templates_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN API templates remaining. REPLACE_ME_WITH_DESCRIPTION_END | | +| `sms_verifications_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN SMS verifications remaining. REPLACE_ME_WITH_DESCRIPTION_END | | +| `num_fax_pages_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of fax pages left REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponseUsage.md b/sdks/php/docs/Model/AccountResponseUsage.md index 3d8c992c2..a109569d1 100644 --- a/sdks/php/docs/Model/AccountResponseUsage.md +++ b/sdks/php/docs/Model/AccountResponseUsage.md @@ -6,6 +6,6 @@ Details concerning monthly usage Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_pages_sent` | ```int``` | Number of fax pages sent | | +| `fax_pages_sent` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of fax pages sent REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountUpdateRequest.md b/sdks/php/docs/Model/AccountUpdateRequest.md index 2eb446a53..afe735eba 100644 --- a/sdks/php/docs/Model/AccountUpdateRequest.md +++ b/sdks/php/docs/Model/AccountUpdateRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The ID of the Account | | -| `callback_url` | ```string``` | The URL that Dropbox Sign should POST events to. | | -| `locale` | ```string``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The ID of the Account REPLACE_ME_WITH_DESCRIPTION_END | | +| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL that Dropbox Sign should POST events to. REPLACE_ME_WITH_DESCRIPTION_END | | +| `locale` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountVerifyRequest.md b/sdks/php/docs/Model/AccountVerifyRequest.md index 756432934..bba185a2f 100644 --- a/sdks/php/docs/Model/AccountVerifyRequest.md +++ b/sdks/php/docs/Model/AccountVerifyRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address`*_required_ | ```string``` | Email address to run the verification for. | | +| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address to run the verification for. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountVerifyResponse.md b/sdks/php/docs/Model/AccountVerifyResponse.md index 6e7849d15..da56a594a 100644 --- a/sdks/php/docs/Model/AccountVerifyResponse.md +++ b/sdks/php/docs/Model/AccountVerifyResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account` | [```\Dropbox\Sign\Model\AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `account` | [```\Dropbox\Sign\Model\AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountVerifyResponseAccount.md b/sdks/php/docs/Model/AccountVerifyResponseAccount.md index ce3508004..4970f76b7 100644 --- a/sdks/php/docs/Model/AccountVerifyResponseAccount.md +++ b/sdks/php/docs/Model/AccountVerifyResponseAccount.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address` | ```string``` | The email address associated with the Account. | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address associated with the Account. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppCreateRequest.md b/sdks/php/docs/Model/ApiAppCreateRequest.md index 09a285a60..ee6f11989 100644 --- a/sdks/php/docs/Model/ApiAppCreateRequest.md +++ b/sdks/php/docs/Model/ApiAppCreateRequest.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `domains`*_required_ | ```string[]``` | The domain names the ApiApp will be associated with. | | -| `name`*_required_ | ```string``` | The name you want to assign to the ApiApp. | | -| `callback_url` | ```string``` | The URL at which the ApiApp should receive event callbacks. | | -| `custom_logo_file` | ```\SplFileObject``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | | -| `oauth` | [```\Dropbox\Sign\Model\SubOAuth```](SubOAuth.md) | | | -| `options` | [```\Dropbox\Sign\Model\SubOptions```](SubOptions.md) | | | -| `white_labeling_options` | [```\Dropbox\Sign\Model\SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | | | +| `domains`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The domain names the ApiApp will be associated with. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name you want to assign to the ApiApp. REPLACE_ME_WITH_DESCRIPTION_END | | +| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL at which the ApiApp should receive event callbacks. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_logo_file` | ```\SplFileObject``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) REPLACE_ME_WITH_DESCRIPTION_END | | +| `oauth` | [```\Dropbox\Sign\Model\SubOAuth```](SubOAuth.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `options` | [```\Dropbox\Sign\Model\SubOptions```](SubOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `white_labeling_options` | [```\Dropbox\Sign\Model\SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppGetResponse.md b/sdks/php/docs/Model/ApiAppGetResponse.md index b47e35c20..3149cb511 100644 --- a/sdks/php/docs/Model/ApiAppGetResponse.md +++ b/sdks/php/docs/Model/ApiAppGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_app`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse```](ApiAppResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `api_app`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse```](ApiAppResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppListResponse.md b/sdks/php/docs/Model/ApiAppListResponse.md index 2eb8ae3c9..94fdceb29 100644 --- a/sdks/php/docs/Model/ApiAppListResponse.md +++ b/sdks/php/docs/Model/ApiAppListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_apps`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse[]```](ApiAppResponse.md) | Contains information about API Apps. | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `api_apps`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse[]```](ApiAppResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains information about API Apps. REPLACE_ME_WITH_DESCRIPTION_END | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponse.md b/sdks/php/docs/Model/ApiAppResponse.md index 975df4b5c..5605e6937 100644 --- a/sdks/php/docs/Model/ApiAppResponse.md +++ b/sdks/php/docs/Model/ApiAppResponse.md @@ -6,15 +6,15 @@ Contains information about an API App. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | The app's callback URL (for events) | | -| `client_id` | ```string``` | The app's client id | | -| `created_at` | ```int``` | The time that the app was created | | -| `domains` | ```string[]``` | The domain name(s) associated with the app | | -| `name` | ```string``` | The name of the app | | -| `is_approved` | ```bool``` | Boolean to indicate if the app has been approved | | -| `oauth` | [```\Dropbox\Sign\Model\ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | -| `options` | [```\Dropbox\Sign\Model\ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `owner_account` | [```\Dropbox\Sign\Model\ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | -| `white_labeling_options` | [```\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | +| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The app's callback URL (for events) REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The app's client id REPLACE_ME_WITH_DESCRIPTION_END | | +| `created_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The time that the app was created REPLACE_ME_WITH_DESCRIPTION_END | | +| `domains` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The domain name(s) associated with the app REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the app REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_approved` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean to indicate if the app has been approved REPLACE_ME_WITH_DESCRIPTION_END | | +| `oauth` | [```\Dropbox\Sign\Model\ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `options` | [```\Dropbox\Sign\Model\ApiAppResponseOptions```](ApiAppResponseOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `owner_account` | [```\Dropbox\Sign\Model\ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `white_labeling_options` | [```\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseOAuth.md b/sdks/php/docs/Model/ApiAppResponseOAuth.md index f6010fe20..b3b82aa32 100644 --- a/sdks/php/docs/Model/ApiAppResponseOAuth.md +++ b/sdks/php/docs/Model/ApiAppResponseOAuth.md @@ -6,9 +6,9 @@ An object describing the app's OAuth properties, or null if OAuth is not con Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | The app's OAuth callback URL. | | -| `secret` | ```string``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```string[]``` | Array of OAuth scopes used by the app. | | -| `charges_users` | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The app's OAuth callback URL. REPLACE_ME_WITH_DESCRIPTION_END | | +| `secret` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The app's OAuth secret, or null if the app does not belong to user. REPLACE_ME_WITH_DESCRIPTION_END | | +| `scopes` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Array of OAuth scopes used by the app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `charges_users` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseOptions.md b/sdks/php/docs/Model/ApiAppResponseOptions.md index 872e8ed0f..7317d847a 100644 --- a/sdks/php/docs/Model/ApiAppResponseOptions.md +++ b/sdks/php/docs/Model/ApiAppResponseOptions.md @@ -6,6 +6,6 @@ An object with options that override account settings. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere` | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `can_insert_everywhere` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean denoting if signers can "Insert Everywhere" in one click while signing a document REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md b/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md index 8f1ce1963..f7e40e40b 100644 --- a/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md +++ b/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md @@ -6,7 +6,7 @@ An object describing the app's owner Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The owner account's ID | | -| `email_address` | ```string``` | The owner account's email address | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The owner account's ID REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The owner account's email address REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md b/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md index 6e963383c..cdf8fd643 100644 --- a/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md @@ -6,19 +6,19 @@ An object with options to customize the app's signer page Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `header_background_color` | ```string``` | | | -| `legal_version` | ```string``` | | | -| `link_color` | ```string``` | | | -| `page_background_color` | ```string``` | | | -| `primary_button_color` | ```string``` | | | -| `primary_button_color_hover` | ```string``` | | | -| `primary_button_text_color` | ```string``` | | | -| `primary_button_text_color_hover` | ```string``` | | | -| `secondary_button_color` | ```string``` | | | -| `secondary_button_color_hover` | ```string``` | | | -| `secondary_button_text_color` | ```string``` | | | -| `secondary_button_text_color_hover` | ```string``` | | | -| `text_color1` | ```string``` | | | -| `text_color2` | ```string``` | | | +| `header_background_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `legal_version` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `link_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `page_background_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `primary_button_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `primary_button_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `primary_button_text_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `primary_button_text_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `secondary_button_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `secondary_button_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `secondary_button_text_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `secondary_button_text_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `text_color1` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `text_color2` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppUpdateRequest.md b/sdks/php/docs/Model/ApiAppUpdateRequest.md index b20923db0..780a08985 100644 --- a/sdks/php/docs/Model/ApiAppUpdateRequest.md +++ b/sdks/php/docs/Model/ApiAppUpdateRequest.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | The URL at which the API App should receive event callbacks. | | -| `custom_logo_file` | ```\SplFileObject``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | | -| `domains` | ```string[]``` | The domain names the ApiApp will be associated with. | | -| `name` | ```string``` | The name you want to assign to the ApiApp. | | -| `oauth` | [```\Dropbox\Sign\Model\SubOAuth```](SubOAuth.md) | | | -| `options` | [```\Dropbox\Sign\Model\SubOptions```](SubOptions.md) | | | -| `white_labeling_options` | [```\Dropbox\Sign\Model\SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | | | +| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL at which the API App should receive event callbacks. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_logo_file` | ```\SplFileObject``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) REPLACE_ME_WITH_DESCRIPTION_END | | +| `domains` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The domain names the ApiApp will be associated with. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name you want to assign to the ApiApp. REPLACE_ME_WITH_DESCRIPTION_END | | +| `oauth` | [```\Dropbox\Sign\Model\SubOAuth```](SubOAuth.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `options` | [```\Dropbox\Sign\Model\SubOptions```](SubOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `white_labeling_options` | [```\Dropbox\Sign\Model\SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobGetResponse.md b/sdks/php/docs/Model/BulkSendJobGetResponse.md index ec44f5b9a..ecf455dcd 100644 --- a/sdks/php/docs/Model/BulkSendJobGetResponse.md +++ b/sdks/php/docs/Model/BulkSendJobGetResponse.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse```](BulkSendJobResponse.md) | | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[]```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `bulk_send_job`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse```](BulkSendJobResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[]```](BulkSendJobGetResponseSignatureRequests.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains information about the Signature Requests sent in bulk. REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md b/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md index 247951d28..b03c52baa 100644 --- a/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md @@ -6,30 +6,33 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `test_mode` | ```bool``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to false] | -| `signature_request_id` | ```string``` | The id of the SignatureRequest. | | -| `requester_email_address` | ```string``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```string``` | The title the specified Account uses for the SignatureRequest. | | -| `original_title` | ```string``` | Default Label for account. | | -| `subject` | ```string``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```string``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```array``` | The metadata attached to the signature request. | | -| `created_at` | ```int``` | Time the signature request was created. | | -| `expires_at` | ```int``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `is_complete` | ```bool``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `is_declined` | ```bool``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `has_error` | ```bool``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `files_url` | ```string``` | The URL where a copy of the request's documents can be downloaded. | | -| `signing_url` | ```string``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `details_url` | ```string``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `cc_email_addresses` | ```string[]``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signing_redirect_url` | ```string``` | The URL you want the signer redirected to after they successfully sign. | | -| `final_copy_uri` | ```string``` | The path where the completed document can be downloaded | | -| `template_ids` | ```string[]``` | Templates IDs used in this SignatureRequest (if any). | | -| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulk_send_job_id` | ```string``` | The id of the BulkSendJob. | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `signature_request_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `requester_email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the initiator of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title the specified Account uses for the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `original_title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Default Label for account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that was initially sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that was initially sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The metadata attached to the signature request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `created_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time the signature request was created. REPLACE_ME_WITH_DESCRIPTION_END | | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_complete` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not the SignatureRequest has been fully executed by all signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_declined` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not the SignatureRequest has been declined by a signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `has_error` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). REPLACE_ME_WITH_DESCRIPTION_END | | +| `files_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where a copy of the request's documents can be downloaded. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. REPLACE_ME_WITH_DESCRIPTION_END | | +| `details_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where the requester and the signers can view the current status of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want the signer redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `final_copy_uri` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The path where the completed document can be downloaded REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_ids` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Templates IDs used in this SignatureRequest (if any). REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of Custom Field objects containing the name and type of each custom field. + +* Text Field uses `SignatureRequestResponseCustomFieldText` +* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` REPLACE_ME_WITH_DESCRIPTION_END | | +| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signer attachments. REPLACE_ME_WITH_DESCRIPTION_END | | +| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of signature objects, 1 for each signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `bulk_send_job_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the BulkSendJob. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobListResponse.md b/sdks/php/docs/Model/BulkSendJobListResponse.md index 470448cd9..be193114d 100644 --- a/sdks/php/docs/Model/BulkSendJobListResponse.md +++ b/sdks/php/docs/Model/BulkSendJobListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_jobs`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse[]```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `bulk_send_jobs`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse[]```](BulkSendJobResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains a list of BulkSendJobs that the API caller has access to. REPLACE_ME_WITH_DESCRIPTION_END | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobResponse.md b/sdks/php/docs/Model/BulkSendJobResponse.md index 16194fdd3..596281b1d 100644 --- a/sdks/php/docs/Model/BulkSendJobResponse.md +++ b/sdks/php/docs/Model/BulkSendJobResponse.md @@ -6,9 +6,9 @@ Contains information about the BulkSendJob such as when it was created and how m Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job_id` | ```string``` | The id of the BulkSendJob. | | -| `total` | ```int``` | The total amount of Signature Requests queued for sending. | | -| `is_creator` | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `created_at` | ```int``` | Time that the BulkSendJob was created. | | +| `bulk_send_job_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the BulkSendJob. REPLACE_ME_WITH_DESCRIPTION_END | | +| `total` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The total amount of Signature Requests queued for sending. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_creator` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. REPLACE_ME_WITH_DESCRIPTION_END | | +| `created_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time that the BulkSendJob was created. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobSendResponse.md b/sdks/php/docs/Model/BulkSendJobSendResponse.md index 83f1c7f8b..ee1575bbc 100644 --- a/sdks/php/docs/Model/BulkSendJobSendResponse.md +++ b/sdks/php/docs/Model/BulkSendJobSendResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse```](BulkSendJobResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `bulk_send_job`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse```](BulkSendJobResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedEditUrlRequest.md b/sdks/php/docs/Model/EmbeddedEditUrlRequest.md index ad008f66e..97ae9ddb8 100644 --- a/sdks/php/docs/Model/EmbeddedEditUrlRequest.md +++ b/sdks/php/docs/Model/EmbeddedEditUrlRequest.md @@ -6,15 +6,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `allow_edit_ccs` | ```bool``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to false] | -| `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | -| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | -| `force_signer_roles` | ```bool``` | Provide users the ability to review/edit the template signer roles. | [default to false] | -| `force_subject_message` | ```bool``` | Provide users the ability to review/edit the template subject and message. | [default to false] | -| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.

Remove all merge fields on the template by passing an empty array `[]`. | | -| `preview_only` | ```bool``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

**NOTE:** This parameter overwrites `show_preview=true` (if set). | [default to false] | -| `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience. | [default to false] | -| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `test_mode` | ```bool``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [default to false] | +| `allow_edit_ccs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable/disable to add or change CC roles when editing the template. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `cc_roles` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `force_signer_roles` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template signer roles. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `force_subject_message` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template subject and message. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. + +Remove all merge fields on the template by passing an empty array `[]`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `preview_only` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). + +**NOTE:** This parameter overwrites `show_preview=true` (if set). REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `show_preview` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the editor/preview experience. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedEditUrlResponse.md b/sdks/php/docs/Model/EmbeddedEditUrlResponse.md index 75b539197..a4aaf8150 100644 --- a/sdks/php/docs/Model/EmbeddedEditUrlResponse.md +++ b/sdks/php/docs/Model/EmbeddedEditUrlResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `embedded`*_required_ | [```\Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `embedded`*_required_ | [```\Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md b/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md index 03d32b4ef..cf95c29d6 100644 --- a/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md +++ b/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md @@ -6,7 +6,7 @@ An embedded template object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `edit_url` | ```string``` | A template url that can be opened in an iFrame. | | -| `expires_at` | ```int``` | The specific time that the the `edit_url` link expires, in epoch. | | +| `edit_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A template url that can be opened in an iFrame. REPLACE_ME_WITH_DESCRIPTION_END | | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The specific time that the the `edit_url` link expires, in epoch. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedSignUrlResponse.md b/sdks/php/docs/Model/EmbeddedSignUrlResponse.md index bbf44ed90..a60c2496e 100644 --- a/sdks/php/docs/Model/EmbeddedSignUrlResponse.md +++ b/sdks/php/docs/Model/EmbeddedSignUrlResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `embedded`*_required_ | [```\Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `embedded`*_required_ | [```\Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md b/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md index a3794eb9e..76480e653 100644 --- a/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md +++ b/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md @@ -6,7 +6,7 @@ An object that contains necessary information to set up embedded signing. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `sign_url` | ```string``` | A signature url that can be opened in an iFrame. | | -| `expires_at` | ```int``` | The specific time that the the `sign_url` link expires, in epoch. | | +| `sign_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A signature url that can be opened in an iFrame. REPLACE_ME_WITH_DESCRIPTION_END | | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The specific time that the the `sign_url` link expires, in epoch. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ErrorResponse.md b/sdks/php/docs/Model/ErrorResponse.md index bfc306713..5f4f504a3 100644 --- a/sdks/php/docs/Model/ErrorResponse.md +++ b/sdks/php/docs/Model/ErrorResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `error`*_required_ | [```\Dropbox\Sign\Model\ErrorResponseError```](ErrorResponseError.md) | | | +| `error`*_required_ | [```\Dropbox\Sign\Model\ErrorResponseError```](ErrorResponseError.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ErrorResponseError.md b/sdks/php/docs/Model/ErrorResponseError.md index b600e94c8..d650d22e6 100644 --- a/sdks/php/docs/Model/ErrorResponseError.md +++ b/sdks/php/docs/Model/ErrorResponseError.md @@ -6,8 +6,8 @@ Contains information about an error that occurred. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `error_msg`*_required_ | ```string``` | Message describing an error. | | -| `error_name`*_required_ | ```string``` | Name of the error. | | -| `error_path` | ```string``` | Path at which an error occurred. | | +| `error_msg`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Message describing an error. REPLACE_ME_WITH_DESCRIPTION_END | | +| `error_name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Name of the error. REPLACE_ME_WITH_DESCRIPTION_END | | +| `error_path` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Path at which an error occurred. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EventCallbackRequest.md b/sdks/php/docs/Model/EventCallbackRequest.md index aeac7154b..6a2bfb545 100644 --- a/sdks/php/docs/Model/EventCallbackRequest.md +++ b/sdks/php/docs/Model/EventCallbackRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `event`*_required_ | [```\Dropbox\Sign\Model\EventCallbackRequestEvent```](EventCallbackRequestEvent.md) | | | -| `account` | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | | | -| `signature_request` | [```\Dropbox\Sign\Model\SignatureRequestResponse```](SignatureRequestResponse.md) | | | -| `template` | [```\Dropbox\Sign\Model\TemplateResponse```](TemplateResponse.md) | | | +| `event`*_required_ | [```\Dropbox\Sign\Model\EventCallbackRequestEvent```](EventCallbackRequestEvent.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `account` | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `signature_request` | [```\Dropbox\Sign\Model\SignatureRequestResponse```](SignatureRequestResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `template` | [```\Dropbox\Sign\Model\TemplateResponse```](TemplateResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EventCallbackRequestEvent.md b/sdks/php/docs/Model/EventCallbackRequestEvent.md index 84a3f872f..e932e37b3 100644 --- a/sdks/php/docs/Model/EventCallbackRequestEvent.md +++ b/sdks/php/docs/Model/EventCallbackRequestEvent.md @@ -6,9 +6,9 @@ Basic information about the event that occurred. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `event_time`*_required_ | ```string``` | Time the event was created (using Unix time). | | -| `event_type`*_required_ | ```string``` | Type of callback event that was triggered. | | -| `event_hash`*_required_ | ```string``` | Generated hash used to verify source of event data. | | -| `event_metadata` | [```\Dropbox\Sign\Model\EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | | +| `event_time`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time the event was created (using Unix time). REPLACE_ME_WITH_DESCRIPTION_END | | +| `event_type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Type of callback event that was triggered. REPLACE_ME_WITH_DESCRIPTION_END | | +| `event_hash`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Generated hash used to verify source of event data. REPLACE_ME_WITH_DESCRIPTION_END | | +| `event_metadata` | [```\Dropbox\Sign\Model\EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md b/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md index 1b7e08e01..89ce5a7f2 100644 --- a/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md +++ b/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md @@ -6,9 +6,9 @@ Specific metadata about the event. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `related_signature_id` | ```string``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | | -| `reported_for_account_id` | ```string``` | Account ID the event was reported for. | | -| `reported_for_app_id` | ```string``` | App ID the event was reported for. | | -| `event_message` | ```string``` | Message about a declined or failed (due to error) signature flow. | | +| `related_signature_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. REPLACE_ME_WITH_DESCRIPTION_END | | +| `reported_for_account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Account ID the event was reported for. REPLACE_ME_WITH_DESCRIPTION_END | | +| `reported_for_app_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN App ID the event was reported for. REPLACE_ME_WITH_DESCRIPTION_END | | +| `event_message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Message about a declined or failed (due to error) signature flow. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxGetResponse.md b/sdks/php/docs/Model/FaxGetResponse.md index 59bea7dc3..8a879bc65 100644 --- a/sdks/php/docs/Model/FaxGetResponse.md +++ b/sdks/php/docs/Model/FaxGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax`*_required_ | [```\Dropbox\Sign\Model\FaxResponse```](FaxResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `fax`*_required_ | [```\Dropbox\Sign\Model\FaxResponse```](FaxResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineAddUserRequest.md b/sdks/php/docs/Model/FaxLineAddUserRequest.md index aef875b22..aa10aafff 100644 --- a/sdks/php/docs/Model/FaxLineAddUserRequest.md +++ b/sdks/php/docs/Model/FaxLineAddUserRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | -| `account_id` | ```string``` | Account ID | | -| `email_address` | ```string``` | Email address | | +| `number`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The Fax Line number REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Account ID REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineAreaCodeGetResponse.md b/sdks/php/docs/Model/FaxLineAreaCodeGetResponse.md index 3f1d9039a..96835f328 100644 --- a/sdks/php/docs/Model/FaxLineAreaCodeGetResponse.md +++ b/sdks/php/docs/Model/FaxLineAreaCodeGetResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `area_codes`*_required_ | ```int[]``` | | | +| `area_codes`*_required_ | ```int[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineCreateRequest.md b/sdks/php/docs/Model/FaxLineCreateRequest.md index 6b599a339..a96a60757 100644 --- a/sdks/php/docs/Model/FaxLineCreateRequest.md +++ b/sdks/php/docs/Model/FaxLineCreateRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `area_code`*_required_ | ```int``` | Area code | | -| `country`*_required_ | ```string``` | Country | | -| `city` | ```string``` | City | | -| `account_id` | ```string``` | Account ID | | +| `area_code`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Area code of the new Fax Line REPLACE_ME_WITH_DESCRIPTION_END | | +| `country`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Country of the area code REPLACE_ME_WITH_DESCRIPTION_END | | +| `city` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN City of the area code REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Account ID of the account that will be assigned this new Fax Line REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineDeleteRequest.md b/sdks/php/docs/Model/FaxLineDeleteRequest.md index a2112ed33..212822459 100644 --- a/sdks/php/docs/Model/FaxLineDeleteRequest.md +++ b/sdks/php/docs/Model/FaxLineDeleteRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The Fax Line number REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineListResponse.md b/sdks/php/docs/Model/FaxLineListResponse.md index 3b6398939..743397886 100644 --- a/sdks/php/docs/Model/FaxLineListResponse.md +++ b/sdks/php/docs/Model/FaxLineListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `fax_lines`*_required_ | [```\Dropbox\Sign\Model\FaxLineResponseFaxLine[]```](FaxLineResponseFaxLine.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse```](WarningResponse.md) | | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `fax_lines`*_required_ | [```\Dropbox\Sign\Model\FaxLineResponseFaxLine[]```](FaxLineResponseFaxLine.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineRemoveUserRequest.md b/sdks/php/docs/Model/FaxLineRemoveUserRequest.md index 6def01071..7a8611beb 100644 --- a/sdks/php/docs/Model/FaxLineRemoveUserRequest.md +++ b/sdks/php/docs/Model/FaxLineRemoveUserRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | -| `account_id` | ```string``` | Account ID | | -| `email_address` | ```string``` | Email address | | +| `number`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The Fax Line number REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Account ID of the user to remove access REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address of the user to remove access REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineResponse.md b/sdks/php/docs/Model/FaxLineResponse.md index 372b1d043..027597275 100644 --- a/sdks/php/docs/Model/FaxLineResponse.md +++ b/sdks/php/docs/Model/FaxLineResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_line`*_required_ | [```\Dropbox\Sign\Model\FaxLineResponseFaxLine```](FaxLineResponseFaxLine.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse```](WarningResponse.md) | | | +| `fax_line`*_required_ | [```\Dropbox\Sign\Model\FaxLineResponseFaxLine```](FaxLineResponseFaxLine.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineResponseFaxLine.md b/sdks/php/docs/Model/FaxLineResponseFaxLine.md index 51f479adc..66ad6e22a 100644 --- a/sdks/php/docs/Model/FaxLineResponseFaxLine.md +++ b/sdks/php/docs/Model/FaxLineResponseFaxLine.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number` | ```string``` | Number | | -| `created_at` | ```int``` | Created at | | -| `updated_at` | ```int``` | Updated at | | -| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | +| `number` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number REPLACE_ME_WITH_DESCRIPTION_END | | +| `created_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Created at REPLACE_ME_WITH_DESCRIPTION_END | | +| `updated_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Updated at REPLACE_ME_WITH_DESCRIPTION_END | | +| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxListResponse.md b/sdks/php/docs/Model/FaxListResponse.md index 5ccdafc91..edd7193e9 100644 --- a/sdks/php/docs/Model/FaxListResponse.md +++ b/sdks/php/docs/Model/FaxListResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `faxes`*_required_ | [```\Dropbox\Sign\Model\FaxResponse[]```](FaxResponse.md) | | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | +| `faxes`*_required_ | [```\Dropbox\Sign\Model\FaxResponse[]```](FaxResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxResponse.md b/sdks/php/docs/Model/FaxResponse.md index 130845b57..52651d68f 100644 --- a/sdks/php/docs/Model/FaxResponse.md +++ b/sdks/php/docs/Model/FaxResponse.md @@ -6,16 +6,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_id`*_required_ | ```string``` | Fax ID | | -| `title`*_required_ | ```string``` | Fax Title | | -| `original_title`*_required_ | ```string``` | Fax Original Title | | -| `metadata`*_required_ | ```array``` | Fax Metadata | | -| `created_at`*_required_ | ```int``` | Fax Created At Timestamp | | -| `sender`*_required_ | ```string``` | Fax Sender Email | | -| `files_url`*_required_ | ```string``` | Fax Files URL | | -| `transmissions`*_required_ | [```\Dropbox\Sign\Model\FaxResponseTransmission[]```](FaxResponseTransmission.md) | Fax Transmissions List | | -| `subject` | ```string``` | Fax Subject | | -| `message` | ```string``` | Fax Message | | -| `final_copy_uri` | ```string``` | The path where the completed document can be downloaded | | +| `fax_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax ID REPLACE_ME_WITH_DESCRIPTION_END | | +| `title`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Title REPLACE_ME_WITH_DESCRIPTION_END | | +| `original_title`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Original Title REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata`*_required_ | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Metadata REPLACE_ME_WITH_DESCRIPTION_END | | +| `created_at`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Created At Timestamp REPLACE_ME_WITH_DESCRIPTION_END | | +| `sender`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Sender Email REPLACE_ME_WITH_DESCRIPTION_END | | +| `files_url`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Files URL REPLACE_ME_WITH_DESCRIPTION_END | | +| `transmissions`*_required_ | [```\Dropbox\Sign\Model\FaxResponseTransmission[]```](FaxResponseTransmission.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Transmissions List REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Subject REPLACE_ME_WITH_DESCRIPTION_END | | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Message REPLACE_ME_WITH_DESCRIPTION_END | | +| `final_copy_uri` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The path where the completed document can be downloaded REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxResponseTransmission.md b/sdks/php/docs/Model/FaxResponseTransmission.md index 353e745f0..0c3ce0498 100644 --- a/sdks/php/docs/Model/FaxResponseTransmission.md +++ b/sdks/php/docs/Model/FaxResponseTransmission.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```string``` | Fax Transmission Recipient | | -| `status_code`*_required_ | ```string``` | Fax Transmission Status Code | | -| `sent_at` | ```int``` | Fax Transmission Sent Timestamp | | +| `recipient`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Transmission Recipient REPLACE_ME_WITH_DESCRIPTION_END | | +| `status_code`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Transmission Status Code REPLACE_ME_WITH_DESCRIPTION_END | | +| `sent_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Transmission Sent Timestamp REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxSendRequest.md b/sdks/php/docs/Model/FaxSendRequest.md index dcbf730c4..238bb8eb6 100644 --- a/sdks/php/docs/Model/FaxSendRequest.md +++ b/sdks/php/docs/Model/FaxSendRequest.md @@ -6,14 +6,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```string``` | Fax Send To Recipient | | -| `sender` | ```string``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```\SplFileObject[]``` | Fax File to Send | | -| `file_urls` | ```string[]``` | Fax File URL to Send | | -| `test_mode` | ```bool``` | API Test Mode Setting | [default to false] | -| `cover_page_to` | ```string``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```string``` | Fax Cover Page for Sender | | -| `cover_page_message` | ```string``` | Fax Cover Page Message | | -| `title` | ```string``` | Fax Title | | +| `recipient`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Recipient of the fax +Can be a phone number in E.164 format or email address REPLACE_ME_WITH_DESCRIPTION_END | | +| `sender` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Send From Sender (used only with fax number) REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to fax + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN API Test Mode Setting REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `cover_page_to` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax cover page recipient information REPLACE_ME_WITH_DESCRIPTION_END | | +| `cover_page_from` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax cover page sender information REPLACE_ME_WITH_DESCRIPTION_END | | +| `cover_page_message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Cover Page Message REPLACE_ME_WITH_DESCRIPTION_END | | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Title REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FileResponse.md b/sdks/php/docs/Model/FileResponse.md index 5803b6565..64d38a591 100644 --- a/sdks/php/docs/Model/FileResponse.md +++ b/sdks/php/docs/Model/FileResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `file_url`*_required_ | ```string``` | URL to the file. | | -| `expires_at`*_required_ | ```int``` | When the link expires. | | +| `file_url`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN URL to the file. REPLACE_ME_WITH_DESCRIPTION_END | | +| `expires_at`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the link expires. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FileResponseDataUri.md b/sdks/php/docs/Model/FileResponseDataUri.md index dbead09b0..fb55e4623 100644 --- a/sdks/php/docs/Model/FileResponseDataUri.md +++ b/sdks/php/docs/Model/FileResponseDataUri.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `data_uri`*_required_ | ```string``` | File as base64 encoded string. | | +| `data_uri`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN File as base64 encoded string. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ListInfoResponse.md b/sdks/php/docs/Model/ListInfoResponse.md index 872ace684..e5a8642c4 100644 --- a/sdks/php/docs/Model/ListInfoResponse.md +++ b/sdks/php/docs/Model/ListInfoResponse.md @@ -6,9 +6,9 @@ Contains pagination information about the data returned. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_pages` | ```int``` | Total number of pages available. | | -| `num_results` | ```int``` | Total number of objects available. | | -| `page` | ```int``` | Number of the page being returned. | | -| `page_size` | ```int``` | Objects returned per page. | | +| `num_pages` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Total number of pages available. REPLACE_ME_WITH_DESCRIPTION_END | | +| `num_results` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Total number of objects available. REPLACE_ME_WITH_DESCRIPTION_END | | +| `page` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of the page being returned. REPLACE_ME_WITH_DESCRIPTION_END | | +| `page_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Objects returned per page. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/OAuthTokenGenerateRequest.md b/sdks/php/docs/Model/OAuthTokenGenerateRequest.md index 40eaf49f9..81c08c51d 100644 --- a/sdks/php/docs/Model/OAuthTokenGenerateRequest.md +++ b/sdks/php/docs/Model/OAuthTokenGenerateRequest.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | The client id of the app requesting authorization. | | -| `client_secret`*_required_ | ```string``` | The secret token of your app. | | -| `code`*_required_ | ```string``` | The code passed to your callback when the user granted access. | | -| `grant_type`*_required_ | ```string``` | When generating a new token use `authorization_code`. | [default to 'authorization_code'] | -| `state`*_required_ | ```string``` | Same as the state you specified earlier. | | +| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The client id of the app requesting authorization. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_secret`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The secret token of your app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `code`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The code passed to your callback when the user granted access. REPLACE_ME_WITH_DESCRIPTION_END | | +| `grant_type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When generating a new token use `authorization_code`. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'authorization_code'] | +| `state`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Same as the state you specified earlier. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/OAuthTokenRefreshRequest.md b/sdks/php/docs/Model/OAuthTokenRefreshRequest.md index 9ba09db42..28728cbc9 100644 --- a/sdks/php/docs/Model/OAuthTokenRefreshRequest.md +++ b/sdks/php/docs/Model/OAuthTokenRefreshRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `grant_type`*_required_ | ```string``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | -| `refresh_token`*_required_ | ```string``` | The token provided when you got the expired access token. | | -| `client_id` | ```string``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | -| `client_secret` | ```string``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `grant_type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When refreshing an existing token use `refresh_token`. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'refresh_token'] | +| `refresh_token`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The token provided when you got the expired access token. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_secret` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/OAuthTokenResponse.md b/sdks/php/docs/Model/OAuthTokenResponse.md index 016f00e9b..0046f9dc3 100644 --- a/sdks/php/docs/Model/OAuthTokenResponse.md +++ b/sdks/php/docs/Model/OAuthTokenResponse.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `access_token` | ```string``` | | | -| `token_type` | ```string``` | | | -| `refresh_token` | ```string``` | | | -| `expires_in` | ```int``` | Number of seconds until the `access_token` expires. Uses epoch time. | | -| `state` | ```string``` | | | +| `access_token` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `token_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `refresh_token` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `expires_in` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of seconds until the `access_token` expires. Uses epoch time. REPLACE_ME_WITH_DESCRIPTION_END | | +| `state` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ReportCreateRequest.md b/sdks/php/docs/Model/ReportCreateRequest.md index 490958a41..32ba37859 100644 --- a/sdks/php/docs/Model/ReportCreateRequest.md +++ b/sdks/php/docs/Model/ReportCreateRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `end_date`*_required_ | ```string``` | The (inclusive) end date for the report data in `MM/DD/YYYY` format. | | -| `report_type`*_required_ | ```string[]``` | The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). | | -| `start_date`*_required_ | ```string``` | The (inclusive) start date for the report data in `MM/DD/YYYY` format. | | +| `end_date`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The (inclusive) end date for the report data in `MM/DD/YYYY` format. REPLACE_ME_WITH_DESCRIPTION_END | | +| `report_type`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). REPLACE_ME_WITH_DESCRIPTION_END | | +| `start_date`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The (inclusive) start date for the report data in `MM/DD/YYYY` format. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ReportCreateResponse.md b/sdks/php/docs/Model/ReportCreateResponse.md index 335d94a47..076c496bb 100644 --- a/sdks/php/docs/Model/ReportCreateResponse.md +++ b/sdks/php/docs/Model/ReportCreateResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `report`*_required_ | [```\Dropbox\Sign\Model\ReportResponse```](ReportResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `report`*_required_ | [```\Dropbox\Sign\Model\ReportResponse```](ReportResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ReportResponse.md b/sdks/php/docs/Model/ReportResponse.md index 3b253ce4e..8a4cc13cb 100644 --- a/sdks/php/docs/Model/ReportResponse.md +++ b/sdks/php/docs/Model/ReportResponse.md @@ -6,9 +6,9 @@ Contains information about the report request. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `success` | ```string``` | A message indicating the requested operation's success | | -| `start_date` | ```string``` | The (inclusive) start date for the report data in MM/DD/YYYY format. | | -| `end_date` | ```string``` | The (inclusive) end date for the report data in MM/DD/YYYY format. | | -| `report_type` | ```string[]``` | The type(s) of the report you are requesting. Allowed values are "user_activity" and "document_status". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). | | +| `success` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A message indicating the requested operation's success REPLACE_ME_WITH_DESCRIPTION_END | | +| `start_date` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The (inclusive) start date for the report data in MM/DD/YYYY format. REPLACE_ME_WITH_DESCRIPTION_END | | +| `end_date` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The (inclusive) end date for the report data in MM/DD/YYYY format. REPLACE_ME_WITH_DESCRIPTION_END | | +| `report_type` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type(s) of the report you are requesting. Allowed values are "user_activity" and "document_status". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index 53be15f83..0f9cc799d 100644 --- a/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -6,18 +6,44 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signer_file` | ```\SplFileObject``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:

- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | | -| `signer_list` | [```\Dropbox\Sign\Model\SubBulkSignerList[]```](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | | -| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | -| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `template_ids`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to create this embedded signature request. Used for security purposes. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_file` | ```\SplFileObject``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: + +- `name`: the name of the signer filling the role of RoleName +- `email_address`: email address of the signer filling the role of RoleName +- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) +- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) + + By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). + + **NOTE:** Not available in test mode and requires a Standard plan or higher. +- `*_field`: any column with a _field" suffix will be treated as a custom field (optional) + + You may only specify field values here, any other options should be set in the custom_fields request parameter. + +Example CSV: + +``` +name, email_address, pin, company_field +George, george@example.com, d79a3td, ABC Corp +Mary, mary@example.com, gd9as5b, 123 LLC +``` REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_list` | [```\Dropbox\Sign\Model\SubBulkSignerList[]```](SubBulkSignerList.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add CC email recipients. Required when a CC role exists for the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + +Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + +For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md index 10d93b867..939031e2a 100644 --- a/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md @@ -6,18 +6,44 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signer_file` | ```\SplFileObject``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:

- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | | -| `signer_list` | [```\Dropbox\Sign\Model\SubBulkSignerList[]```](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | | -| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | -| `client_id` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | -| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `template_ids`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_file` | ```\SplFileObject``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: + +- `name`: the name of the signer filling the role of RoleName +- `email_address`: email address of the signer filling the role of RoleName +- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) +- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) + + By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). + + **NOTE:** Not available in test mode and requires a Standard plan or higher. +- `*_field`: any column with a _field" suffix will be treated as a custom field (optional) + + You may only specify field values here, any other options should be set in the custom_fields request parameter. + +Example CSV: + +``` +name, email_address, pin, company_field +George, george@example.com, d79a3td, ABC Corp +Mary, mary@example.com, gd9as5b, 123 LLC +``` REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_list` | [```\Dropbox\Sign\Model\SubBulkSignerList[]```](SubBulkSignerList.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add CC email recipients. Required when a CC role exists for the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + +Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + +For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md index a953bcbc2..9b55e281e 100644 --- a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md @@ -6,29 +6,62 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | -| `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | -| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | -| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | -| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | -| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | -| `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | -| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | -| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to create this embedded signature request. Used for security purposes. REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Signature Request. + +This endpoint requires either **signers** or **grouped_signers**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Grouped Signers to your Signature Request. + +This endpoint requires either **signers** or **grouped_signers**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + +**NOTE:** Only available for Premium plan. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | +| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email addresses that should be CCed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + +Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + +For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + +**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + +* Text Field use `SubFormFieldsPerDocumentText` +* Dropdown Field use `SubFormFieldsPerDocumentDropdown` +* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` +* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` +* Radio Field use `SubFormFieldsPerDocumentRadio` +* Signature Field use `SubFormFieldsPerDocumentSignature` +* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` +* Initials Field use `SubFormFieldsPerDocumentInitials` +* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` +* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | +| `hide_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Enables automatic Text Tag removal when set to true. + +**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `use_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `populate_auto_fill_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. + +**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md index b41a8e311..385dae2b1 100644 --- a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -6,20 +6,28 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | -| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | -| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | -| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | -| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `template_ids`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to create this embedded signature request. Used for security purposes. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Templated-based Signature Request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add CC email recipients. Required when a CC role exists for the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array defining values and options for custom fields. Required when a custom field exists in the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `populate_auto_fill_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. + +**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestGetResponse.md b/sdks/php/docs/Model/SignatureRequestGetResponse.md index c2f3c97b7..e3eb44ee0 100644 --- a/sdks/php/docs/Model/SignatureRequestGetResponse.md +++ b/sdks/php/docs/Model/SignatureRequestGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_request`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse```](SignatureRequestResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `signature_request`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse```](SignatureRequestResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestListResponse.md b/sdks/php/docs/Model/SignatureRequestListResponse.md index c0aae36cd..7f1614f15 100644 --- a/sdks/php/docs/Model/SignatureRequestListResponse.md +++ b/sdks/php/docs/Model/SignatureRequestListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse[]```](SignatureRequestResponse.md) | Contains information about signature requests. | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse[]```](SignatureRequestResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains information about signature requests. REPLACE_ME_WITH_DESCRIPTION_END | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestRemindRequest.md b/sdks/php/docs/Model/SignatureRequestRemindRequest.md index e8b9292f8..5fa71821c 100644 --- a/sdks/php/docs/Model/SignatureRequestRemindRequest.md +++ b/sdks/php/docs/Model/SignatureRequestRemindRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address`*_required_ | ```string``` | The email address of the signer to send a reminder to. | | -| `name` | ```string``` | The name of the signer to send a reminder to. Include if two or more signers share an email address. | | +| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer to send a reminder to. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer to send a reminder to. Include if two or more signers share an email address. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponse.md b/sdks/php/docs/Model/SignatureRequestResponse.md index bb04b5d30..63d2f4351 100644 --- a/sdks/php/docs/Model/SignatureRequestResponse.md +++ b/sdks/php/docs/Model/SignatureRequestResponse.md @@ -6,30 +6,33 @@ Contains information about a signature request. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `test_mode` | ```bool``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to false] | -| `signature_request_id` | ```string``` | The id of the SignatureRequest. | | -| `requester_email_address` | ```string``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```string``` | The title the specified Account uses for the SignatureRequest. | | -| `original_title` | ```string``` | Default Label for account. | | -| `subject` | ```string``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```string``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```array``` | The metadata attached to the signature request. | | -| `created_at` | ```int``` | Time the signature request was created. | | -| `expires_at` | ```int``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `is_complete` | ```bool``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `is_declined` | ```bool``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `has_error` | ```bool``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `files_url` | ```string``` | The URL where a copy of the request's documents can be downloaded. | | -| `signing_url` | ```string``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `details_url` | ```string``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `cc_email_addresses` | ```string[]``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signing_redirect_url` | ```string``` | The URL you want the signer redirected to after they successfully sign. | | -| `final_copy_uri` | ```string``` | The path where the completed document can be downloaded | | -| `template_ids` | ```string[]``` | Templates IDs used in this SignatureRequest (if any). | | -| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulk_send_job_id` | ```string``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `signature_request_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `requester_email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the initiator of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title the specified Account uses for the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `original_title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Default Label for account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that was initially sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that was initially sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The metadata attached to the signature request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `created_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time the signature request was created. REPLACE_ME_WITH_DESCRIPTION_END | | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_complete` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not the SignatureRequest has been fully executed by all signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_declined` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not the SignatureRequest has been declined by a signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `has_error` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). REPLACE_ME_WITH_DESCRIPTION_END | | +| `files_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where a copy of the request's documents can be downloaded. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. REPLACE_ME_WITH_DESCRIPTION_END | | +| `details_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where the requester and the signers can view the current status of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want the signer redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `final_copy_uri` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The path where the completed document can be downloaded REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_ids` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Templates IDs used in this SignatureRequest (if any). REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of Custom Field objects containing the name and type of each custom field. + +* Text Field uses `SignatureRequestResponseCustomFieldText` +* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` REPLACE_ME_WITH_DESCRIPTION_END | | +| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signer attachments. REPLACE_ME_WITH_DESCRIPTION_END | | +| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of signature objects, 1 for each signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `bulk_send_job_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The ID of the Bulk Send job which sent the signature request, if applicable. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseAttachment.md b/sdks/php/docs/Model/SignatureRequestResponseAttachment.md index 6e84393ae..601358432 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseAttachment.md +++ b/sdks/php/docs/Model/SignatureRequestResponseAttachment.md @@ -6,11 +6,11 @@ Signer attachments. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `id`*_required_ | ```string``` | The unique ID for this attachment. | | -| `signer`*_required_ | ```string``` | The Signer this attachment is assigned to. | | -| `name`*_required_ | ```string``` | The name of this attachment. | | -| `required`*_required_ | ```bool``` | A boolean value denoting if this attachment is required. | | -| `instructions` | ```string``` | Instructions for Signer. | | -| `uploaded_at` | ```int``` | Timestamp when attachment was uploaded by Signer. | | +| `id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The unique ID for this attachment. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The Signer this attachment is assigned to. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of this attachment. REPLACE_ME_WITH_DESCRIPTION_END | | +| `required`*_required_ | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A boolean value denoting if this attachment is required. REPLACE_ME_WITH_DESCRIPTION_END | | +| `instructions` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Instructions for Signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `uploaded_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Timestamp when attachment was uploaded by Signer. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md index 40685da58..88017781c 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md +++ b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md @@ -2,17 +2,17 @@ An array of Custom Field objects containing the name and type of each custom field. -* Text Field uses `SignatureRequestResponseCustomFieldText` -* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` +* Text Field uses `SignatureRequestResponseCustomFieldText` +* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `name`*_required_ | ```string``` | The name of the Custom Field. | | -| `required` | ```bool``` | A boolean value denoting if this field is required. | | -| `api_id` | ```string``` | The unique ID for this field. | | -| `editor` | ```string``` | The name of the Role that is able to edit this field. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the Custom Field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A boolean value denoting if this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | +| `api_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The unique ID for this field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `editor` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the Role that is able to edit this field. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md index 08c64f658..695550b8e 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md +++ b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md @@ -1,12 +1,12 @@ # # SignatureRequestResponseCustomFieldCheckbox -This class extends `SignatureRequestResponseCustomFieldBase`. +This class extends `SignatureRequestResponseCustomFieldBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'checkbox'] | -| `value` | ```bool``` | A true/false for checkbox fields | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | +| `value` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A true/false for checkbox fields REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md index 38486e804..a73ed1b8f 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md +++ b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md @@ -1,12 +1,12 @@ # # SignatureRequestResponseCustomFieldText -This class extends `SignatureRequestResponseCustomFieldBase`. +This class extends `SignatureRequestResponseCustomFieldBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'text'] | -| `value` | ```string``` | A text string for text fields | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | +| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A text string for text fields REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataBase.md b/sdks/php/docs/Model/SignatureRequestResponseDataBase.md index 7a1f3ef03..f4752ef79 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataBase.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataBase.md @@ -6,10 +6,10 @@ An array of form field objects containing the name, value, and type of each text Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_id` | ```string``` | The unique ID for this field. | | -| `signature_id` | ```string``` | The ID of the signature to which this response is linked. | | -| `name` | ```string``` | The name of the form field. | | -| `required` | ```bool``` | A boolean value denoting if this field is required. | | -| `type` | ```string``` | | | +| `api_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The unique ID for this field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signature_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The ID of the signature to which this response is linked. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A boolean value denoting if this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md index dfdc66f06..aa6bdd92c 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A yes/no checkbox | [default to 'checkbox'] | -| `value` | ```bool``` | The value of the form field. | | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A yes/no checkbox REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | +| `value` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md index 00475b7bd..153d2003f 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A checkbox field that has default value set by the api | [default to 'checkbox-merge'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A checkbox field that has default value set by the api REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox-merge'] | +| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md index 56a613c94..f8e063b7a 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A date | [default to 'date_signed'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A date REPLACE_ME_WITH_DESCRIPTION_END | [default to 'date_signed'] | +| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md index 61ddaae67..fd962c060 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | An input field for dropdowns | [default to 'dropdown'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for dropdowns REPLACE_ME_WITH_DESCRIPTION_END | [default to 'dropdown'] | +| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md index f4bf660f6..9b74912fe 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | An input field for initials | [default to 'initials'] | -| `value` | ```string``` | The value of the form field. | | -| `is_signed` | ```bool``` | This field contains the boolean true if the field is signed. | | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for initials REPLACE_ME_WITH_DESCRIPTION_END | [default to 'initials'] | +| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_signed` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This field contains the boolean true if the field is signed. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md index e5de3e9af..7c53889da 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | An input field for radios | [default to 'radio'] | -| `value` | ```bool``` | The value of the form field. | | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for radios REPLACE_ME_WITH_DESCRIPTION_END | [default to 'radio'] | +| `value` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md index 877febbcd..321cd3918 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A signature input field | [default to 'signature'] | -| `value` | ```string``` | The value of the form field. | | -| `is_signed` | ```bool``` | This field contains the boolean true if the field is signed. | | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A signature input field REPLACE_ME_WITH_DESCRIPTION_END | [default to 'signature'] | +| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_signed` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This field contains the boolean true if the field is signed. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md index 6058f2017..0c1c88a04 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A text input field | [default to 'text'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A text input field REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | +| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md index e1b140727..962e7146b 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A text field that has default text set by the api | [default to 'text-merge'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A text field that has default text set by the api REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text-merge'] | +| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseSignatures.md b/sdks/php/docs/Model/SignatureRequestResponseSignatures.md index 6d49a3089..2de63767b 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseSignatures.md +++ b/sdks/php/docs/Model/SignatureRequestResponseSignatures.md @@ -6,24 +6,24 @@ An array of signature objects, 1 for each signer. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_id` | ```string``` | Signature identifier. | | -| `signer_group_guid` | ```string``` | Signer Group GUID | | -| `signer_email_address` | ```string``` | The email address of the signer. | | -| `signer_name` | ```string``` | The name of the signer. | | -| `signer_role` | ```string``` | The role of the signer. | | -| `order` | ```int``` | If signer order is assigned this is the 0-based index for this signer. | | -| `status_code` | ```string``` | The current status of the signature. eg: awaiting_signature, signed, declined. | | -| `decline_reason` | ```string``` | The reason provided by the signer for declining the request. | | -| `signed_at` | ```int``` | Time that the document was signed or null. | | -| `last_viewed_at` | ```int``` | The time that the document was last viewed by this signer or null. | | -| `last_reminded_at` | ```int``` | The time the last reminder email was sent to the signer or null. | | -| `has_pin` | ```bool``` | Boolean to indicate whether this signature requires a PIN to access. | | -| `has_sms_auth` | ```bool``` | Boolean to indicate whether this signature has SMS authentication enabled. | | -| `has_sms_delivery` | ```bool``` | Boolean to indicate whether this signature has SMS delivery enabled. | | -| `sms_phone_number` | ```string``` | The SMS phone number used for authentication or signature request delivery. | | -| `reassigned_by` | ```string``` | Email address of original signer who reassigned to this signer. | | -| `reassignment_reason` | ```string``` | Reason provided by original signer who reassigned to this signer. | | -| `reassigned_from` | ```string``` | Previous signature identifier. | | -| `error` | ```string``` | Error message pertaining to this signer, or null. | | +| `signature_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signature identifier. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_group_guid` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signer Group GUID REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_role` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The role of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN If signer order is assigned this is the 0-based index for this signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `status_code` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The current status of the signature. eg: awaiting_signature, signed, declined. REPLACE_ME_WITH_DESCRIPTION_END | | +| `decline_reason` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The reason provided by the signer for declining the request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signed_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time that the document was signed or null. REPLACE_ME_WITH_DESCRIPTION_END | | +| `last_viewed_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The time that the document was last viewed by this signer or null. REPLACE_ME_WITH_DESCRIPTION_END | | +| `last_reminded_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The time the last reminder email was sent to the signer or null. REPLACE_ME_WITH_DESCRIPTION_END | | +| `has_pin` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean to indicate whether this signature requires a PIN to access. REPLACE_ME_WITH_DESCRIPTION_END | | +| `has_sms_auth` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean to indicate whether this signature has SMS authentication enabled. REPLACE_ME_WITH_DESCRIPTION_END | | +| `has_sms_delivery` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean to indicate whether this signature has SMS delivery enabled. REPLACE_ME_WITH_DESCRIPTION_END | | +| `sms_phone_number` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The SMS phone number used for authentication or signature request delivery. REPLACE_ME_WITH_DESCRIPTION_END | | +| `reassigned_by` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address of original signer who reassigned to this signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `reassignment_reason` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Reason provided by original signer who reassigned to this signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `reassigned_from` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Previous signature identifier. REPLACE_ME_WITH_DESCRIPTION_END | | +| `error` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Error message pertaining to this signer, or null. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestSendRequest.md b/sdks/php/docs/Model/SignatureRequestSendRequest.md index 65d3a7d91..bbd64c005 100644 --- a/sdks/php/docs/Model/SignatureRequestSendRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendRequest.md @@ -6,31 +6,69 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | -| `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | -| `client_id` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | -| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | -| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | -| `is_qualified_signature` | ```bool``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | -| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | -| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | -| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | -| `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | -| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Signature Request. + +This endpoint requires either **signers** or **grouped_signers**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Grouped Signers to your Signature Request. + +This endpoint requires either **signers** or **grouped_signers**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + +**NOTE:** Only available for Premium plan and higher. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | +| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email addresses that should be CCed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + +Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + +For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + +**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + +* Text Field use `SubFormFieldsPerDocumentText` +* Dropdown Field use `SubFormFieldsPerDocumentDropdown` +* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` +* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` +* Radio Field use `SubFormFieldsPerDocumentRadio` +* Signature Field use `SubFormFieldsPerDocumentSignature` +* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` +* Initials Field use `SubFormFieldsPerDocumentInitials` +* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` +* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | +| `hide_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Enables automatic Text Tag removal when set to true. + +**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `is_qualified_signature` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable +[Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), +which requires a face-to-face call to verify the signer's identity.<br> +**NOTE:** QES is only available on the Premium API plan as an add-on purchase. +Cannot be used in `test_mode`. Only works on requests with one signer. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `is_eid` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable +[electronic identification (eID)](https://www.hellosign.com/features/electronic-id), +which requires the signer to verify their identity with an eID provider to sign a document.<br> +**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `use_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md index cbfaeb338..e7de13434 100644 --- a/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md @@ -6,22 +6,35 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | -| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | -| `client_id` | ```string``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | -| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `is_qualified_signature` | ```bool``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | -| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | -| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | -| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `template_ids`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Templated-based Signature Request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add CC email recipients. Required when a CC role exists for the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array defining values and options for custom fields. Required when a custom field exists in the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_qualified_signature` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable +[Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), +which requires a face-to-face call to verify the signer's identity.<br> +**NOTE:** QES is only available on the Premium API plan as an add-on purchase. +Cannot be used in `test_mode`. Only works on requests with one signer. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `is_eid` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable +[electronic identification (eID)](https://www.hellosign.com/features/electronic-id), +which requires the signer to verify their identity with an eID provider to sign a document.<br> +**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestUpdateRequest.md b/sdks/php/docs/Model/SignatureRequestUpdateRequest.md index abccc2572..2e91cfac8 100644 --- a/sdks/php/docs/Model/SignatureRequestUpdateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestUpdateRequest.md @@ -6,9 +6,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_id`*_required_ | ```string``` | The signature ID for the recipient. | | -| `email_address` | ```string``` | The new email address for the recipient.

This will generate a new `signature_id` value.

**NOTE:** Optional if `name` is provided. | | -| `name` | ```string``` | The new name for the recipient.

**NOTE:** Optional if `email_address` is provided. | | -| `expires_at` | ```int``` | The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signature_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The signature ID for the recipient. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The new email address for the recipient. + +This will generate a new `signature_id` value. + +**NOTE:** Optional if `name` is provided. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The new name for the recipient. + +**NOTE:** Optional if `email_address` is provided. REPLACE_ME_WITH_DESCRIPTION_END | | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubAttachment.md b/sdks/php/docs/Model/SubAttachment.md index 3f87942f8..b61101dab 100644 --- a/sdks/php/docs/Model/SubAttachment.md +++ b/sdks/php/docs/Model/SubAttachment.md @@ -6,9 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of attachment. | | -| `signer_index`*_required_ | ```int``` | The signer's index in the `signers` parameter (0-based indexing).

**NOTE:** Only one signer can be assigned per attachment. | | -| `instructions` | ```string``` | The instructions for uploading the attachment. | | -| `required` | ```bool``` | Determines if the attachment must be uploaded. | [default to false] | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of attachment. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_index`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The signer's index in the `signers` parameter (0-based indexing). + +**NOTE:** Only one signer can be assigned per attachment. REPLACE_ME_WITH_DESCRIPTION_END | | +| `instructions` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The instructions for uploading the attachment. REPLACE_ME_WITH_DESCRIPTION_END | | +| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Determines if the attachment must be uploaded. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubBulkSignerList.md b/sdks/php/docs/Model/SubBulkSignerList.md index 9842742e5..63c577a16 100644 --- a/sdks/php/docs/Model/SubBulkSignerList.md +++ b/sdks/php/docs/Model/SubBulkSignerList.md @@ -6,7 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `custom_fields` | [```\Dropbox\Sign\Model\SubBulkSignerListCustomField[]```](SubBulkSignerListCustomField.md) | An array of custom field values. | | -| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.

Currently only templates with a single role are supported. All signers must have the same `role` value. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubBulkSignerListCustomField[]```](SubBulkSignerListCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of custom field values. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. + +Currently only templates with a single role are supported. All signers must have the same `role` value. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubBulkSignerListCustomField.md b/sdks/php/docs/Model/SubBulkSignerListCustomField.md index 0eca191cb..5f2b59500 100644 --- a/sdks/php/docs/Model/SubBulkSignerListCustomField.md +++ b/sdks/php/docs/Model/SubBulkSignerListCustomField.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the custom field. Must be the field's `name` or `api_id`. | | -| `value`*_required_ | ```string``` | The value of the custom field. | | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the custom field. Must be the field's `name` or `api_id`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `value`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the custom field. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubCC.md b/sdks/php/docs/Model/SubCC.md index 2f77e26db..ff3ff75db 100644 --- a/sdks/php/docs/Model/SubCC.md +++ b/sdks/php/docs/Model/SubCC.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```string``` | Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role. | | -| `email_address`*_required_ | ```string``` | The email address of the CC recipient. | | +| `role`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the CC recipient. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubCustomField.md b/sdks/php/docs/Model/SubCustomField.md index ff1b713d7..6d6a62803 100644 --- a/sdks/php/docs/Model/SubCustomField.md +++ b/sdks/php/docs/Model/SubCustomField.md @@ -1,18 +1,20 @@ # # SubCustomField -When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. +When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. -Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. +Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. -For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. +For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing. | | -| `editor` | ```string``` | Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.

**NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. | | -| `required` | ```bool``` | Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`. | [default to false] | -| `value` | ```string``` | The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing. | | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing. REPLACE_ME_WITH_DESCRIPTION_END | | +| `editor` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. + +**NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. REPLACE_ME_WITH_DESCRIPTION_END | | +| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubEditorOptions.md b/sdks/php/docs/Model/SubEditorOptions.md index 2cffacfa1..023c069a3 100644 --- a/sdks/php/docs/Model/SubEditorOptions.md +++ b/sdks/php/docs/Model/SubEditorOptions.md @@ -6,7 +6,7 @@ This allows the requester to specify editor options when a preparing a document Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `allow_edit_signers` | ```bool``` | Allows requesters to edit the list of signers | [default to false] | -| `allow_edit_documents` | ```bool``` | Allows requesters to edit documents, including delete and add | [default to false] | +| `allow_edit_signers` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows requesters to edit the list of signers REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `allow_edit_documents` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows requesters to edit documents, including delete and add REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFieldOptions.md b/sdks/php/docs/Model/SubFieldOptions.md index f8f275ebe..2e458fb2e 100644 --- a/sdks/php/docs/Model/SubFieldOptions.md +++ b/sdks/php/docs/Model/SubFieldOptions.md @@ -6,6 +6,8 @@ This allows the requester to specify field options for a signature request. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `date_format`*_required_ | ```string``` | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))

**NOTE:** Only available for Premium and higher. | | +| `date_format`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) + +**NOTE:** Only available for Premium and higher. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldGroup.md b/sdks/php/docs/Model/SubFormFieldGroup.md index 006da0dc1..5bba51dc4 100644 --- a/sdks/php/docs/Model/SubFormFieldGroup.md +++ b/sdks/php/docs/Model/SubFormFieldGroup.md @@ -6,8 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `group_id`*_required_ | ```string``` | ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`. | | -| `group_label`*_required_ | ```string``` | Name of the group | | -| `requirement`*_required_ | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `group_label`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Name of the group REPLACE_ME_WITH_DESCRIPTION_END | | +| `requirement`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Examples: `require_0-1` `require_1` `require_1-ormore` + +- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). +- Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). +- Radio groups require **at least** two fields per group. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldRule.md b/sdks/php/docs/Model/SubFormFieldRule.md index fca10b343..f7d49d01a 100644 --- a/sdks/php/docs/Model/SubFormFieldRule.md +++ b/sdks/php/docs/Model/SubFormFieldRule.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `id`*_required_ | ```string``` | Must be unique across all defined rules. | | -| `trigger_operator`*_required_ | ```string``` | Currently only `AND` is supported. Support for `OR` is being worked on. | [default to 'AND'] | -| `triggers`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldRuleTrigger[]```](SubFormFieldRuleTrigger.md) | An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed. | | -| `actions`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldRuleAction[]```](SubFormFieldRuleAction.md) | An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule. | | +| `id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Must be unique across all defined rules. REPLACE_ME_WITH_DESCRIPTION_END | | +| `trigger_operator`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Currently only `AND` is supported. Support for `OR` is being worked on. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'AND'] | +| `triggers`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldRuleTrigger[]```](SubFormFieldRuleTrigger.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `actions`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldRuleAction[]```](SubFormFieldRuleAction.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldRuleAction.md b/sdks/php/docs/Model/SubFormFieldRuleAction.md index 0c4b275a6..5b4d8ed0e 100644 --- a/sdks/php/docs/Model/SubFormFieldRuleAction.md +++ b/sdks/php/docs/Model/SubFormFieldRuleAction.md @@ -6,9 +6,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `hidden`*_required_ | ```bool``` | `true` to hide the target field when rule is satisfied, otherwise `false`. | | -| `type`*_required_ | ```string``` | | | -| `field_id` | ```string``` | **field_id** or **group_id** is required, but not both.

Must reference the `api_id` of an existing field defined within `form_fields_per_document`.

Cannot use with `group_id`. Trigger and action fields must belong to the same signer. | | -| `group_id` | ```string``` | **group_id** or **field_id** is required, but not both.

Must reference the ID of an existing group defined within `form_field_groups`.

Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer. | | +| `hidden`*_required_ | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `true` to hide the target field when rule is satisfied, otherwise `false`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `field_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **field_id** or **group_id** is required, but not both. + +Must reference the `api_id` of an existing field defined within `form_fields_per_document`. + +Cannot use with `group_id`. Trigger and action fields must belong to the same signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `group_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **group_id** or **field_id** is required, but not both. + +Must reference the ID of an existing group defined within `form_field_groups`. + +Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldRuleTrigger.md b/sdks/php/docs/Model/SubFormFieldRuleTrigger.md index da2141ef0..88b155f26 100644 --- a/sdks/php/docs/Model/SubFormFieldRuleTrigger.md +++ b/sdks/php/docs/Model/SubFormFieldRuleTrigger.md @@ -6,9 +6,42 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `id`*_required_ | ```string``` | Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer. | | -| `operator`*_required_ | ```string``` | Different field types allow different `operator` values: - Field type of **text**: - **is**: exact match - **not**: not exact match - **match**: regular expression, without /. Example: - OK `[a-zA-Z0-9]` - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**: - **is**: exact match, single value - **not**: not exact match, single value - **any**: exact match, array of values. - **none**: not exact match, array of values. - Field type of **checkbox**: - **is**: exact match, single value - **not**: not exact match, single value - Field type of **radio**: - **is**: exact match, single value - **not**: not exact match, single value | | -| `value` | ```string``` | **value** or **values** is required, but not both.

The value to match against **operator**.

- When **operator** is one of the following, **value** must be `String`: - `is` - `not` - `match`

Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1` | | -| `values` | ```string[]``` | **values** or **value** is required, but not both.

The values to match against **operator** when it is one of the following:

- `any` - `none` | | +| `id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `operator`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Different field types allow different `operator` values: +- Field type of **text**: + - **is**: exact match + - **not**: not exact match + - **match**: regular expression, without /. Example: + - OK `[a-zA-Z0-9]` + - Not OK `/[a-zA-Z0-9]/` +- Field type of **dropdown**: + - **is**: exact match, single value + - **not**: not exact match, single value + - **any**: exact match, array of values. + - **none**: not exact match, array of values. +- Field type of **checkbox**: + - **is**: exact match, single value + - **not**: not exact match, single value +- Field type of **radio**: + - **is**: exact match, single value + - **not**: not exact match, single value REPLACE_ME_WITH_DESCRIPTION_END | | +| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **value** or **values** is required, but not both. + +The value to match against **operator**. + +- When **operator** is one of the following, **value** must be `String`: + - `is` + - `not` + - `match` + +Otherwise, +- **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` +- **radio**: When **type** of trigger is **radio**, **value** must be `1` REPLACE_ME_WITH_DESCRIPTION_END | | +| `values` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **values** or **value** is required, but not both. + +The values to match against **operator** when it is one of the following: + +- `any` +- `none` REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md index 7c7f4c293..5381de32c 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md @@ -4,31 +4,38 @@ The fields that should appear on the document, expressed as an array of objects. **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. -* Text Field use `SubFormFieldsPerDocumentText` -* Dropdown Field use `SubFormFieldsPerDocumentDropdown` -* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` -* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` -* Radio Field use `SubFormFieldsPerDocumentRadio` -* Signature Field use `SubFormFieldsPerDocumentSignature` -* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` -* Initials Field use `SubFormFieldsPerDocumentInitials` -* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` -* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` +* Text Field use `SubFormFieldsPerDocumentText` +* Dropdown Field use `SubFormFieldsPerDocumentDropdown` +* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` +* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` +* Radio Field use `SubFormFieldsPerDocumentRadio` +* Signature Field use `SubFormFieldsPerDocumentSignature` +* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` +* Initials Field use `SubFormFieldsPerDocumentInitials` +* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` +* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `document_index`*_required_ | ```int``` | Represents the integer index of the `file` or `file_url` document the field should be attached to. | | -| `api_id`*_required_ | ```string``` | An identifier for the field that is unique across all documents in the request. | | -| `height`*_required_ | ```int``` | Size of the field in pixels. | | -| `required`*_required_ | ```bool``` | Whether this field is required. | | -| `signer`*_required_ | ```string``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | | -| `type`*_required_ | ```string``` | | | -| `width`*_required_ | ```int``` | Size of the field in pixels. | | -| `x`*_required_ | ```int``` | Location coordinates of the field in pixels. | | -| `y`*_required_ | ```int``` | Location coordinates of the field in pixels. | | -| `name` | ```string``` | Display name for the field. | | -| `page` | ```int``` | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | | +| `document_index`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Represents the integer index of the `file` or `file_url` document the field should be attached to. REPLACE_ME_WITH_DESCRIPTION_END | | +| `api_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An identifier for the field that is unique across all documents in the request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `height`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Size of the field in pixels. REPLACE_ME_WITH_DESCRIPTION_END | | +| `required`*_required_ | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. + +**NOTE:** To set the value of the field as the preparer you must set this to `me_now` + +**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `width`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Size of the field in pixels. REPLACE_ME_WITH_DESCRIPTION_END | | +| `x`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Location coordinates of the field in pixels. REPLACE_ME_WITH_DESCRIPTION_END | | +| `y`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Location coordinates of the field in pixels. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Display name for the field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `page` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Page in the document where the field should be placed (requires documents be PDF files). + +- When the page number parameter is supplied, the API will use the new coordinate system. +- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckbox.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckbox.md index 57e306cbf..e3c9f2f0a 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckbox.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckbox.md @@ -1,13 +1,13 @@ # # SubFormFieldsPerDocumentCheckbox -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class. | [default to 'checkbox'] | -| `is_checked`*_required_ | ```bool``` | `true` for checking the checkbox field by default, otherwise `false`. | | -| `group` | ```string``` | String referencing group defined in `form_field_groups` parameter. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | +| `is_checked`*_required_ | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `true` for checking the checkbox field by default, otherwise `false`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN String referencing group defined in `form_field_groups` parameter. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckboxMerge.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckboxMerge.md index d959793a0..a37b87afa 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckboxMerge.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckboxMerge.md @@ -1,11 +1,11 @@ # # SubFormFieldsPerDocumentCheckboxMerge -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class. | [default to 'checkbox-merge'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox-merge'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentDateSigned.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentDateSigned.md index d33f346ce..d8eba3f97 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentDateSigned.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentDateSigned.md @@ -1,13 +1,15 @@ # # SubFormFieldsPerDocumentDateSigned -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | [default to 'date_signed'] | -| `font_family` | ```string``` | Font family for the field. | | -| `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A date. Use the `SubFormFieldsPerDocumentDateSigned` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'date_signed'] | +| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family for the field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The initial px font size for the field contents. Can be any integer value between `7` and `49`. + +**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 12] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentDropdown.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentDropdown.md index c670a097e..e8ea4e2ca 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentDropdown.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentDropdown.md @@ -1,15 +1,17 @@ # # SubFormFieldsPerDocumentDropdown -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class. | [default to 'dropdown'] | -| `options`*_required_ | ```string[]``` | Array of string values representing dropdown values. | | -| `content` | ```string``` | Selected value in `options` array. Value must exist in array. | | -| `font_family` | ```string``` | Font family for the field. | | -| `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'dropdown'] | +| `options`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Array of string values representing dropdown values. REPLACE_ME_WITH_DESCRIPTION_END | | +| `content` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Selected value in `options` array. Value must exist in array. REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family for the field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The initial px font size for the field contents. Can be any integer value between `7` and `49`. + +**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 12] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentHyperlink.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentHyperlink.md index 0cb90a64f..4dd186a61 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentHyperlink.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentHyperlink.md @@ -1,15 +1,17 @@ # # SubFormFieldsPerDocumentHyperlink -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. | [default to 'hyperlink'] | -| `content`*_required_ | ```string``` | Link Text. | | -| `content_url`*_required_ | ```string``` | Link URL. | | -| `font_family` | ```string``` | Font family for the field. | | -| `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'hyperlink'] | +| `content`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Link Text. REPLACE_ME_WITH_DESCRIPTION_END | | +| `content_url`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Link URL. REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family for the field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The initial px font size for the field contents. Can be any integer value between `7` and `49`. + +**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 12] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentInitials.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentInitials.md index ccb50121e..7c33a53b7 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentInitials.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentInitials.md @@ -1,11 +1,11 @@ # # SubFormFieldsPerDocumentInitials -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class. | [default to 'initials'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'initials'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentRadio.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentRadio.md index 6d40f86e6..097e3ce13 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentRadio.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentRadio.md @@ -1,13 +1,13 @@ # # SubFormFieldsPerDocumentRadio -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class. | [default to 'radio'] | -| `group`*_required_ | ```string``` | String referencing group defined in `form_field_groups` parameter. | | -| `is_checked`*_required_ | ```bool``` | `true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'radio'] | +| `group`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN String referencing group defined in `form_field_groups` parameter. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_checked`*_required_ | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentSignature.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentSignature.md index 9b800232f..c85f68728 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentSignature.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentSignature.md @@ -1,11 +1,11 @@ # # SubFormFieldsPerDocumentSignature -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | A signature input field. Use the `SubFormFieldsPerDocumentSignature` class. | [default to 'signature'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A signature input field. Use the `SubFormFieldsPerDocumentSignature` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'signature'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md index c41a60817..466789871 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md @@ -1,21 +1,25 @@ # # SubFormFieldsPerDocumentText -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | A text input field. Use the `SubFormFieldsPerDocumentText` class. | [default to 'text'] | -| `placeholder` | ```string``` | Placeholder value for text field. | | -| `auto_fill_type` | ```string``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | | -| `link_id` | ```string``` | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | | -| `masked` | ```bool``` | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | | -| `validation_type` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.

**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | | -| `validation_custom_regex` | ```string``` | | | -| `validation_custom_regex_format_label` | ```string``` | | | -| `content` | ```string``` | Content of a `me_now` text field | | -| `font_family` | ```string``` | Font family for the field. | | -| `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A text input field. Use the `SubFormFieldsPerDocumentText` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | +| `placeholder` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Placeholder value for text field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `auto_fill_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. REPLACE_ME_WITH_DESCRIPTION_END | | +| `link_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. REPLACE_ME_WITH_DESCRIPTION_END | | +| `masked` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `validation_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + +**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. REPLACE_ME_WITH_DESCRIPTION_END | | +| `validation_custom_regex` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `validation_custom_regex_format_label` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `content` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Content of a `me_now` text field REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family for the field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The initial px font size for the field contents. Can be any integer value between `7` and `49`. + +**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 12] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md index 40c07308f..e4036697d 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md @@ -1,13 +1,15 @@ # # SubFormFieldsPerDocumentTextMerge -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] | -| `font_family` | ```string``` | Font family for the field. | | -| `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text-merge'] | +| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family for the field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The initial px font size for the field contents. Can be any integer value between `7` and `49`. + +**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 12] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubMergeField.md b/sdks/php/docs/Model/SubMergeField.md index 1114a084b..1236c2712 100644 --- a/sdks/php/docs/Model/SubMergeField.md +++ b/sdks/php/docs/Model/SubMergeField.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the merge field. Must be unique. | | -| `type`*_required_ | ```string``` | The type of merge field. | | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the merge field. Must be unique. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of merge field. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubOAuth.md b/sdks/php/docs/Model/SubOAuth.md index 26088e668..48ee87f15 100644 --- a/sdks/php/docs/Model/SubOAuth.md +++ b/sdks/php/docs/Model/SubOAuth.md @@ -6,7 +6,7 @@ OAuth related parameters. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | | -| `scopes` | ```string[]``` | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | | +| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) REPLACE_ME_WITH_DESCRIPTION_END | | +| `scopes` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubOptions.md b/sdks/php/docs/Model/SubOptions.md index 926c89eab..5b1d68b42 100644 --- a/sdks/php/docs/Model/SubOptions.md +++ b/sdks/php/docs/Model/SubOptions.md @@ -6,6 +6,6 @@ Additional options supported by API App. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere` | ```bool``` | Determines if signers can use "Insert Everywhere" when signing a document. | [default to false] | +| `can_insert_everywhere` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Determines if signers can use "Insert Everywhere" when signing a document. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md b/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md index 69275147a..9dc8e7ed0 100644 --- a/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md +++ b/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md @@ -6,8 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `group`*_required_ | ```string``` | The name of the group. | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Signers belonging to this Group.

**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. | | -| `order` | ```int``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | | +| `group`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signers belonging to this Group. + +**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. REPLACE_ME_WITH_DESCRIPTION_END | | +| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The order the group is required to sign in. Use this instead of Signer-level `order`. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSignatureRequestSigner.md b/sdks/php/docs/Model/SubSignatureRequestSigner.md index 8ba880dd0..ffb1380f1 100644 --- a/sdks/php/docs/Model/SubSignatureRequestSigner.md +++ b/sdks/php/docs/Model/SubSignatureRequestSigner.md @@ -6,11 +6,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the signer. | | -| `email_address`*_required_ | ```string``` | The email address of the signer. | | -| `order` | ```int``` | The order the signer is required to sign in. | | -| `pin` | ```string``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `sms_phone_number` | ```string``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `sms_phone_number_type` | ```string``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The order the signer is required to sign in. REPLACE_ME_WITH_DESCRIPTION_END | | +| `pin` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The 4- to 12-character access code that will secure this signer's signature page. REPLACE_ME_WITH_DESCRIPTION_END | | +| `sms_phone_number` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An E.164 formatted phone number. + +By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). + +**NOTE:** Not available in test mode and requires a Standard plan or higher. REPLACE_ME_WITH_DESCRIPTION_END | | +| `sms_phone_number_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Specifies the feature used with the `sms_phone_number`. Default `authentication`. + +If `authentication`, signer is sent a verification code via SMS that is required to access the document. + +If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md b/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md index 5b1995c0b..276f5dec8 100644 --- a/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md +++ b/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md @@ -6,11 +6,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```string``` | Must match an existing role in chosen Template(s). It's case-sensitive. | | -| `name`*_required_ | ```string``` | The name of the signer. | | -| `email_address`*_required_ | ```string``` | The email address of the signer. | | -| `pin` | ```string``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `sms_phone_number` | ```string``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `sms_phone_number_type` | ```string``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `role`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Must match an existing role in chosen Template(s). It's case-sensitive. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `pin` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The 4- to 12-character access code that will secure this signer's signature page. REPLACE_ME_WITH_DESCRIPTION_END | | +| `sms_phone_number` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An E.164 formatted phone number. + +By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). + +**NOTE:** Not available in test mode and requires a Standard plan or higher. REPLACE_ME_WITH_DESCRIPTION_END | | +| `sms_phone_number_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Specifies the feature used with the `sms_phone_number`. Default `authentication`. + +If `authentication`, signer is sent a verification code via SMS that is required to access the document. + +If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSigningOptions.md b/sdks/php/docs/Model/SubSigningOptions.md index e2a1b1660..56cb56434 100644 --- a/sdks/php/docs/Model/SubSigningOptions.md +++ b/sdks/php/docs/Model/SubSigningOptions.md @@ -2,16 +2,16 @@ This allows the requester to specify the types allowed for creating a signature. -**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `default_type`*_required_ | ```string``` | The default type shown (limited to the listed types) | | -| `draw` | ```bool``` | Allows drawing the signature | [default to false] | -| `phone` | ```bool``` | Allows using a smartphone to email the signature | [default to false] | -| `type` | ```bool``` | Allows typing the signature | [default to false] | -| `upload` | ```bool``` | Allows uploading the signature | [default to false] | +| `default_type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The default type shown (limited to the listed types) REPLACE_ME_WITH_DESCRIPTION_END | | +| `draw` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows drawing the signature REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `phone` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows using a smartphone to email the signature REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `type` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows typing the signature REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `upload` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows uploading the signature REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubTeamResponse.md b/sdks/php/docs/Model/SubTeamResponse.md index e0c954d29..659e96685 100644 --- a/sdks/php/docs/Model/SubTeamResponse.md +++ b/sdks/php/docs/Model/SubTeamResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```string``` | The id of a team | | -| `name` | ```string``` | The name of a team | | +| `team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of a team REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of a team REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubTemplateRole.md b/sdks/php/docs/Model/SubTemplateRole.md index 062527156..d24f7e99b 100644 --- a/sdks/php/docs/Model/SubTemplateRole.md +++ b/sdks/php/docs/Model/SubTemplateRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The role name of the signer that will be displayed when the template is used to create a signature request. | | -| `order` | ```int``` | The order in which this signer role is required to sign. | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The role name of the signer that will be displayed when the template is used to create a signature request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The order in which this signer role is required to sign. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubUnclaimedDraftSigner.md b/sdks/php/docs/Model/SubUnclaimedDraftSigner.md index d5849d712..6e4c6270a 100644 --- a/sdks/php/docs/Model/SubUnclaimedDraftSigner.md +++ b/sdks/php/docs/Model/SubUnclaimedDraftSigner.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address`*_required_ | ```string``` | The email address of the signer. | | -| `name`*_required_ | ```string``` | The name of the signer. | | -| `order` | ```int``` | The order the signer is required to sign in. | | +| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The order the signer is required to sign in. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md b/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md index 3c20fd2e7..942d15c1c 100644 --- a/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md +++ b/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```string``` | Must match an existing role in chosen Template(s). | | -| `name`*_required_ | ```string``` | The name of the signer filling the role of `role`. | | -| `email_address`*_required_ | ```string``` | The email address of the signer filling the role of `role`. | | +| `role`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Must match an existing role in chosen Template(s). REPLACE_ME_WITH_DESCRIPTION_END | | +| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer filling the role of `role`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer filling the role of `role`. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubWhiteLabelingOptions.md b/sdks/php/docs/Model/SubWhiteLabelingOptions.md index 976f55aaa..4319bed5b 100644 --- a/sdks/php/docs/Model/SubWhiteLabelingOptions.md +++ b/sdks/php/docs/Model/SubWhiteLabelingOptions.md @@ -8,20 +8,20 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `header_background_color` | ```string``` | | [default to '#1a1a1a'] | -| `legal_version` | ```string``` | | [default to 'terms1'] | -| `link_color` | ```string``` | | [default to '#0061FE'] | -| `page_background_color` | ```string``` | | [default to '#f7f8f9'] | -| `primary_button_color` | ```string``` | | [default to '#0061FE'] | -| `primary_button_color_hover` | ```string``` | | [default to '#0061FE'] | -| `primary_button_text_color` | ```string``` | | [default to '#ffffff'] | -| `primary_button_text_color_hover` | ```string``` | | [default to '#ffffff'] | -| `secondary_button_color` | ```string``` | | [default to '#ffffff'] | -| `secondary_button_color_hover` | ```string``` | | [default to '#ffffff'] | -| `secondary_button_text_color` | ```string``` | | [default to '#0061FE'] | -| `secondary_button_text_color_hover` | ```string``` | | [default to '#0061FE'] | -| `text_color1` | ```string``` | | [default to '#808080'] | -| `text_color2` | ```string``` | | [default to '#ffffff'] | -| `reset_to_default` | ```bool``` | Resets white labeling options to defaults. Only useful when updating an API App. | | +| `header_background_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#1a1a1a'] | +| `legal_version` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to 'terms1'] | +| `link_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#0061FE'] | +| `page_background_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#f7f8f9'] | +| `primary_button_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#0061FE'] | +| `primary_button_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#0061FE'] | +| `primary_button_text_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#ffffff'] | +| `primary_button_text_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#ffffff'] | +| `secondary_button_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#ffffff'] | +| `secondary_button_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#ffffff'] | +| `secondary_button_text_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#0061FE'] | +| `secondary_button_text_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#0061FE'] | +| `text_color1` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#808080'] | +| `text_color2` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#ffffff'] | +| `reset_to_default` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Resets white labeling options to defaults. Only useful when updating an API App. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamAddMemberRequest.md b/sdks/php/docs/Model/TeamAddMemberRequest.md index 4606ecdcb..3f0b39137 100644 --- a/sdks/php/docs/Model/TeamAddMemberRequest.md +++ b/sdks/php/docs/Model/TeamAddMemberRequest.md @@ -6,8 +6,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | `account_id` or `email_address` is required. If both are provided, the account id prevails.

Account id of the user to invite to your Team. | | -| `email_address` | ```string``` | `account_id` or `email_address` is required, If both are provided, the account id prevails.

Email address of the user to invite to your Team. | | -| `role` | ```string``` | A role member will take in a new Team.

**NOTE:** This parameter is used only if `team_id` is provided. | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `account_id` or `email_address` is required. If both are provided, the account id prevails. + +Account id of the user to invite to your Team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `account_id` or `email_address` is required, If both are provided, the account id prevails. + +Email address of the user to invite to your Team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `role` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A role member will take in a new Team. + +**NOTE:** This parameter is used only if `team_id` is provided. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamCreateRequest.md b/sdks/php/docs/Model/TeamCreateRequest.md index 29c05f9a3..46d4cc0d2 100644 --- a/sdks/php/docs/Model/TeamCreateRequest.md +++ b/sdks/php/docs/Model/TeamCreateRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of your Team. | [default to 'Untitled Team'] | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of your Team. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'Untitled Team'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamGetInfoResponse.md b/sdks/php/docs/Model/TeamGetInfoResponse.md index 6250ae721..a2757b114 100644 --- a/sdks/php/docs/Model/TeamGetInfoResponse.md +++ b/sdks/php/docs/Model/TeamGetInfoResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team`*_required_ | [```\Dropbox\Sign\Model\TeamInfoResponse```](TeamInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `team`*_required_ | [```\Dropbox\Sign\Model\TeamInfoResponse```](TeamInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamGetResponse.md b/sdks/php/docs/Model/TeamGetResponse.md index 0d65f9000..b5bcac844 100644 --- a/sdks/php/docs/Model/TeamGetResponse.md +++ b/sdks/php/docs/Model/TeamGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team`*_required_ | [```\Dropbox\Sign\Model\TeamResponse```](TeamResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `team`*_required_ | [```\Dropbox\Sign\Model\TeamResponse```](TeamResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamInfoResponse.md b/sdks/php/docs/Model/TeamInfoResponse.md index 6db4a64c2..c44fc478d 100644 --- a/sdks/php/docs/Model/TeamInfoResponse.md +++ b/sdks/php/docs/Model/TeamInfoResponse.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```string``` | The id of a team | | -| `team_parent` | [```\Dropbox\Sign\Model\TeamParentResponse```](TeamParentResponse.md) | | | -| `name` | ```string``` | The name of a team | | -| `num_members` | ```int``` | Number of members within a team | | -| `num_sub_teams` | ```int``` | Number of sub teams within a team | | +| `team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of a team REPLACE_ME_WITH_DESCRIPTION_END | | +| `team_parent` | [```\Dropbox\Sign\Model\TeamParentResponse```](TeamParentResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of a team REPLACE_ME_WITH_DESCRIPTION_END | | +| `num_members` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of members within a team REPLACE_ME_WITH_DESCRIPTION_END | | +| `num_sub_teams` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of sub teams within a team REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamInviteResponse.md b/sdks/php/docs/Model/TeamInviteResponse.md index 6ca84d844..cd33f7af0 100644 --- a/sdks/php/docs/Model/TeamInviteResponse.md +++ b/sdks/php/docs/Model/TeamInviteResponse.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address` | ```string``` | Email address of the user invited to this team. | | -| `team_id` | ```string``` | Id of the team. | | -| `role` | ```string``` | Role of the user invited to this team. | | -| `sent_at` | ```int``` | Timestamp when the invitation was sent. | | -| `redeemed_at` | ```int``` | Timestamp when the invitation was redeemed. | | -| `expires_at` | ```int``` | Timestamp when the invitation is expiring. | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address of the user invited to this team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Id of the team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `role` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Role of the user invited to this team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `sent_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Timestamp when the invitation was sent. REPLACE_ME_WITH_DESCRIPTION_END | | +| `redeemed_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Timestamp when the invitation was redeemed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Timestamp when the invitation is expiring. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamInvitesResponse.md b/sdks/php/docs/Model/TeamInvitesResponse.md index 64d96b25b..f2f17bbaa 100644 --- a/sdks/php/docs/Model/TeamInvitesResponse.md +++ b/sdks/php/docs/Model/TeamInvitesResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_invites`*_required_ | [```\Dropbox\Sign\Model\TeamInviteResponse[]```](TeamInviteResponse.md) | Contains a list of team invites and their roles. | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | | | +| `team_invites`*_required_ | [```\Dropbox\Sign\Model\TeamInviteResponse[]```](TeamInviteResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains a list of team invites and their roles. REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamMemberResponse.md b/sdks/php/docs/Model/TeamMemberResponse.md index 2ff4a44f9..4c8fcd70d 100644 --- a/sdks/php/docs/Model/TeamMemberResponse.md +++ b/sdks/php/docs/Model/TeamMemberResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | Account id of the team member. | | -| `email_address` | ```string``` | Email address of the team member. | | -| `role` | ```string``` | The specific role a member has on the team. | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Account id of the team member. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address of the team member. REPLACE_ME_WITH_DESCRIPTION_END | | +| `role` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The specific role a member has on the team. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamMembersResponse.md b/sdks/php/docs/Model/TeamMembersResponse.md index 0474722c4..23bf36e60 100644 --- a/sdks/php/docs/Model/TeamMembersResponse.md +++ b/sdks/php/docs/Model/TeamMembersResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_members`*_required_ | [```\Dropbox\Sign\Model\TeamMemberResponse[]```](TeamMemberResponse.md) | Contains a list of team members and their roles for a specific team. | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | | | +| `team_members`*_required_ | [```\Dropbox\Sign\Model\TeamMemberResponse[]```](TeamMemberResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains a list of team members and their roles for a specific team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamParentResponse.md b/sdks/php/docs/Model/TeamParentResponse.md index 376880069..241255572 100644 --- a/sdks/php/docs/Model/TeamParentResponse.md +++ b/sdks/php/docs/Model/TeamParentResponse.md @@ -1,12 +1,12 @@ # # TeamParentResponse -Information about the parent team if a team has one, set to `null` otherwise. +Information about the parent team if a team has one, set to `null` otherwise. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```string``` | The id of a team | | -| `name` | ```string``` | The name of a team | | +| `team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of a team REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of a team REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamRemoveMemberRequest.md b/sdks/php/docs/Model/TeamRemoveMemberRequest.md index 39672f4b2..5f11d2f0b 100644 --- a/sdks/php/docs/Model/TeamRemoveMemberRequest.md +++ b/sdks/php/docs/Model/TeamRemoveMemberRequest.md @@ -6,10 +6,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | **account_id** or **email_address** is required. If both are provided, the account id prevails.

Account id to remove from your Team. | | -| `email_address` | ```string``` | **account_id** or **email_address** is required. If both are provided, the account id prevails.

Email address of the Account to remove from your Team. | | -| `new_owner_email_address` | ```string``` | The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.

**NOTE:** Only available for Enterprise plans. | | -| `new_team_id` | ```string``` | Id of the new Team. | | -| `new_role` | ```string``` | A new role member will take in a new Team.

**NOTE:** This parameter is used only if `new_team_id` is provided. | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **account_id** or **email_address** is required. If both are provided, the account id prevails. + +Account id to remove from your Team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **account_id** or **email_address** is required. If both are provided, the account id prevails. + +Email address of the Account to remove from your Team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `new_owner_email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account. + +**NOTE:** Only available for Enterprise plans. REPLACE_ME_WITH_DESCRIPTION_END | | +| `new_team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Id of the new Team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `new_role` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A new role member will take in a new Team. + +**NOTE:** This parameter is used only if `new_team_id` is provided. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamResponse.md b/sdks/php/docs/Model/TeamResponse.md index 4aea582c9..5929025f0 100644 --- a/sdks/php/docs/Model/TeamResponse.md +++ b/sdks/php/docs/Model/TeamResponse.md @@ -6,9 +6,9 @@ Contains information about your team and its members Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of your Team | | -| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | -| `invited_accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invited_emails` | ```string[]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of your Team REPLACE_ME_WITH_DESCRIPTION_END | | +| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `invited_accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `invited_emails` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamSubTeamsResponse.md b/sdks/php/docs/Model/TeamSubTeamsResponse.md index 9a37ce150..f30690d36 100644 --- a/sdks/php/docs/Model/TeamSubTeamsResponse.md +++ b/sdks/php/docs/Model/TeamSubTeamsResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `sub_teams`*_required_ | [```\Dropbox\Sign\Model\SubTeamResponse[]```](SubTeamResponse.md) | Contains a list with sub teams. | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | | | +| `sub_teams`*_required_ | [```\Dropbox\Sign\Model\SubTeamResponse[]```](SubTeamResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains a list with sub teams. REPLACE_ME_WITH_DESCRIPTION_END | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamUpdateRequest.md b/sdks/php/docs/Model/TeamUpdateRequest.md index 604a6012f..b171fa684 100644 --- a/sdks/php/docs/Model/TeamUpdateRequest.md +++ b/sdks/php/docs/Model/TeamUpdateRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of your Team. | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of your Team. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateAddUserRequest.md b/sdks/php/docs/Model/TemplateAddUserRequest.md index e552d463d..8c2d00bb9 100644 --- a/sdks/php/docs/Model/TemplateAddUserRequest.md +++ b/sdks/php/docs/Model/TemplateAddUserRequest.md @@ -6,8 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The id of the Account to give access to the Template.
**NOTE:** The account id prevails if email address is also provided. | | -| `email_address` | ```string``` | The email address of the Account to give access to the Template.
**NOTE:** The account id prevails if it is also provided. | | -| `skip_notification` | ```bool``` | If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`. | [default to false] | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Account to give access to the Template. +**NOTE:** The account id prevails if email address is also provided. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the Account to give access to the Template. +**NOTE:** The account id prevails if it is also provided. REPLACE_ME_WITH_DESCRIPTION_END | | +| `skip_notification` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md index d9ef188de..159835621 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md @@ -6,30 +6,55 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | -| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to true] | -| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | -| `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request | | -| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | -| `force_signer_roles` | ```bool``` | Provide users the ability to review/edit the template signer roles. | [default to false] | -| `force_subject_message` | ```bool``` | Provide users the ability to review/edit the template subject and message. | [default to false] | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | -| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | -| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | -| `message` | ```string``` | The default template email message. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] | -| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signer_roles` | [```\Dropbox\Sign\Model\SubTemplateRole[]```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `skip_me_now` | ```bool``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | -| `subject` | ```string``` | The template title (alias). | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | -| `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_ccs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | +| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + +**NOTE:** Only available for Premium plan and higher. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | +| `cc_roles` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The CC roles that must be assigned when using the template to send a signature request REPLACE_ME_WITH_DESCRIPTION_END | | +| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `force_signer_roles` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template signer roles. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `force_subject_message` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template subject and message. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + +**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + +* Text Field use `SubFormFieldsPerDocumentText` +* Dropdown Field use `SubFormFieldsPerDocumentDropdown` +* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` +* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` +* Radio Field use `SubFormFieldsPerDocumentRadio` +* Signature Field use `SubFormFieldsPerDocumentSignature` +* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` +* Initials Field use `SubFormFieldsPerDocumentInitials` +* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` +* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | +| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. +If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. REPLACE_ME_WITH_DESCRIPTION_END | | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The default template email message. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `show_preview` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the editor/preview experience. + +- `show_preview=true`: Allows requesters to enable the editor/preview experience. +- `show_preview=false`: Allows requesters to disable the editor/preview experience. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | +| `signer_roles` | [```\Dropbox\Sign\Model\SubTemplateRole[]```](SubTemplateRole.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `skip_me_now` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The template title (alias). REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `use_preexisting_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md index 439aa708e..f2a052175 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md index 7604fd299..18c368d45 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -1,14 +1,14 @@ # # TemplateCreateEmbeddedDraftResponseTemplate -Template object with parameters: `template_id`, `edit_url`, `expires_at`. +Template object with parameters: `template_id`, `edit_url`, `expires_at`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | -| `edit_url` | ```string``` | Link to edit the template. | | -| `expires_at` | ```int``` | When the link expires. | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `template_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `edit_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Link to edit the template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the link expires. REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateRequest.md b/sdks/php/docs/Model/TemplateCreateRequest.md index 1a4b677f1..e962f4486 100644 --- a/sdks/php/docs/Model/TemplateCreateRequest.md +++ b/sdks/php/docs/Model/TemplateCreateRequest.md @@ -6,23 +6,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `form_fields_per_document`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | -| `signer_roles`*_required_ | [```\Dropbox\Sign\Model\SubTemplateRole[]```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | -| `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request | | -| `client_id` | ```string``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | -| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | -| `message` | ```string``` | The default template email message. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `subject` | ```string``` | The template title (alias). | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | -| `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `form_fields_per_document`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + +**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + +* Text Field use `SubFormFieldsPerDocumentText` +* Dropdown Field use `SubFormFieldsPerDocumentDropdown` +* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` +* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` +* Radio Field use `SubFormFieldsPerDocumentRadio` +* Signature Field use `SubFormFieldsPerDocumentSignature` +* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` +* Initials Field use `SubFormFieldsPerDocumentInitials` +* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` +* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_roles`*_required_ | [```\Dropbox\Sign\Model\SubTemplateRole[]```](SubTemplateRole.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + +**NOTE:** Only available for Premium plan and higher. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | +| `cc_roles` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The CC roles that must be assigned when using the template to send a signature request REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. +If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. REPLACE_ME_WITH_DESCRIPTION_END | | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The default template email message. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The template title (alias). REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `use_preexisting_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateResponse.md b/sdks/php/docs/Model/TemplateCreateResponse.md index 676d2acca..1c77743b1 100644 --- a/sdks/php/docs/Model/TemplateCreateResponse.md +++ b/sdks/php/docs/Model/TemplateCreateResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md index 0f25586c5..a290126c2 100644 --- a/sdks/php/docs/Model/TemplateCreateResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md @@ -1,11 +1,11 @@ # # TemplateCreateResponseTemplate -Template object with parameters: `template_id`. +Template object with parameters: `template_id`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | +| `template_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateEditResponse.md b/sdks/php/docs/Model/TemplateEditResponse.md index b343db573..587ed6b24 100644 --- a/sdks/php/docs/Model/TemplateEditResponse.md +++ b/sdks/php/docs/Model/TemplateEditResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```string``` | The id of the Template. | | +| `template_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateGetResponse.md b/sdks/php/docs/Model/TemplateGetResponse.md index 0aba7b381..425abd9bb 100644 --- a/sdks/php/docs/Model/TemplateGetResponse.md +++ b/sdks/php/docs/Model/TemplateGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse```](TemplateResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse```](TemplateResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateListResponse.md b/sdks/php/docs/Model/TemplateListResponse.md index 9723b1385..7a943c864 100644 --- a/sdks/php/docs/Model/TemplateListResponse.md +++ b/sdks/php/docs/Model/TemplateListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse[]```](TemplateResponse.md) | List of templates that the API caller has access to. | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `templates`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse[]```](TemplateResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN List of templates that the API caller has access to. REPLACE_ME_WITH_DESCRIPTION_END | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateRemoveUserRequest.md b/sdks/php/docs/Model/TemplateRemoveUserRequest.md index 591eb5d25..4991df58e 100644 --- a/sdks/php/docs/Model/TemplateRemoveUserRequest.md +++ b/sdks/php/docs/Model/TemplateRemoveUserRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | | -| `email_address` | ```string``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponse.md b/sdks/php/docs/Model/TemplateResponse.md index 3a7dc2f03..9f1695b82 100644 --- a/sdks/php/docs/Model/TemplateResponse.md +++ b/sdks/php/docs/Model/TemplateResponse.md @@ -6,21 +6,23 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | -| `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `updated_at` | ```int``` | Time the template was last updated. | | -| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | -| `is_creator` | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit` | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked` | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```array``` | The metadata attached to the template. | | -| `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `template_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `updated_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time the template was last updated. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_embedded` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_creator` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `true` if you are the owner of this template, `false` if it's been shared with you by a team member. REPLACE_ME_WITH_DESCRIPTION_END | | +| `can_edit` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_locked` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Indicates whether the template is locked. +If `true`, then the template was created outside your quota and can only be used in `test_mode`. +If `false`, then the template is within your quota and can be used to create signature requests. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The metadata attached to the template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `documents` | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array describing each document associated with this Template. Includes form field data for each document. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. REPLACE_ME_WITH_DESCRIPTION_END | | +| `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. REPLACE_ME_WITH_DESCRIPTION_END | | +| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of the Accounts that can use this Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signer attachments. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseAccount.md b/sdks/php/docs/Model/TemplateResponseAccount.md index fb9563bbc..dc61f7dc7 100644 --- a/sdks/php/docs/Model/TemplateResponseAccount.md +++ b/sdks/php/docs/Model/TemplateResponseAccount.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The id of the Account. | | -| `email_address` | ```string``` | The email address associated with the Account. | | -| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```\Dropbox\Sign\Model\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | +| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address associated with the Account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_locked` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has been locked out of their account by a team admin. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_paid_hs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has a paid Dropbox Sign account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_paid_hf` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has a paid HelloFax account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `quotas` | [```\Dropbox\Sign\Model\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseAccountQuota.md b/sdks/php/docs/Model/TemplateResponseAccountQuota.md index 7b106a9ac..f40c26140 100644 --- a/sdks/php/docs/Model/TemplateResponseAccountQuota.md +++ b/sdks/php/docs/Model/TemplateResponseAccountQuota.md @@ -6,9 +6,9 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates_left` | ```int``` | API templates remaining. | | -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | +| `templates_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN API templates remaining. REPLACE_ME_WITH_DESCRIPTION_END | | +| `api_signature_requests_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN API signature requests remaining. REPLACE_ME_WITH_DESCRIPTION_END | | +| `documents_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signature requests remaining. REPLACE_ME_WITH_DESCRIPTION_END | | +| `sms_verifications_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN SMS verifications remaining. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseCCRole.md b/sdks/php/docs/Model/TemplateResponseCCRole.md index 32ad82ef9..80ff66611 100644 --- a/sdks/php/docs/Model/TemplateResponseCCRole.md +++ b/sdks/php/docs/Model/TemplateResponseCCRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the Role. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocument.md b/sdks/php/docs/Model/TemplateResponseDocument.md index ab0518d3a..d1c5e1f72 100644 --- a/sdks/php/docs/Model/TemplateResponseDocument.md +++ b/sdks/php/docs/Model/TemplateResponseDocument.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | Name of the associated file. | | -| `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `field_groups` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Name of the associated file. REPLACE_ME_WITH_DESCRIPTION_END | | +| `index` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Document ordering, the lowest index is displayed first and the highest last (0-based indexing). REPLACE_ME_WITH_DESCRIPTION_END | | +| `field_groups` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of Form Field Group objects. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of Form Field objects containing the name and type of each named field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of Form Field objects containing the name and type of each named field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md index 47b5bad52..1d26d087a 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md @@ -6,15 +6,15 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | The unique ID for this field. | | -| `name` | ```string``` | The name of the Custom Field. | | -| `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `api_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The unique ID for this field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the Custom Field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). REPLACE_ME_WITH_DESCRIPTION_END | | +| `x` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The horizontal offset in pixels for this form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `y` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The vertical offset in pixels for this form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `width` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The width in pixels of this form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `height` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The height in pixels of this form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean showing whether or not this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | +| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null`. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md index 4b1e53fb0..931fba73f 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md @@ -1,11 +1,14 @@ # # TemplateResponseDocumentCustomFieldCheckbox -This class extends `TemplateResponseDocumentCustomFieldBase` +This class extends `TemplateResponseDocumentCustomFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'checkbox'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this Custom Field. Only `text` and `checkbox` are currently supported. + +* Text uses `TemplateResponseDocumentCustomFieldText` +* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md index 68e40af6b..7a49e5846 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md @@ -1,15 +1,18 @@ # # TemplateResponseDocumentCustomFieldText -This class extends `TemplateResponseDocumentCustomFieldBase` +This class extends `TemplateResponseDocumentCustomFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this Custom Field. Only `text` and `checkbox` are currently supported. + +* Text uses `TemplateResponseDocumentCustomFieldText` +* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | +| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_multiline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this form field is multiline text. REPLACE_ME_WITH_DESCRIPTION_END | | +| `original_font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Original font size used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md index 233352654..e312e17b3 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the form field group. | | -| `rule` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the form field group. REPLACE_ME_WITH_DESCRIPTION_END | | +| `rule` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md index ad79e834e..9ef7f0ffb 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md @@ -6,7 +6,11 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement` | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `group_label` | ```string``` | Name of the group | | +| `requirement` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Examples: `require_0-1` `require_1` `require_1-ormore` + +- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). +- Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). +- Radio groups require **at least** two fields per group. REPLACE_ME_WITH_DESCRIPTION_END | | +| `group_label` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Name of the group REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md index f792fdfed..23baa5753 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md @@ -6,14 +6,14 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | A unique id for the form field. | | -| `name` | ```string``` | The name of the form field. | | -| `signer` | ```string``` | The signer of the Form Field. | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `api_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A unique id for the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The signer of the Form Field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `x` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The horizontal offset in pixels for this form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `y` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The vertical offset in pixels for this form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `width` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The width in pixels of this form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `height` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The height in pixels of this form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean showing whether or not this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md index 2ee1b9e5e..849256a35 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md @@ -1,12 +1,21 @@ # # TemplateResponseDocumentFormFieldCheckbox -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentFormFieldText` +* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentFormFieldRadio` +* Signature Field uses `TemplateResponseDocumentFormFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | +| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md index 8996ce7a3..491aff76a 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md @@ -1,12 +1,21 @@ # # TemplateResponseDocumentFormFieldDateSigned -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentFormFieldText` +* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentFormFieldRadio` +* Signature Field uses `TemplateResponseDocumentFormFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'date_signed'] | +| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md index 35cadabb5..f81d66b9a 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md @@ -1,12 +1,21 @@ # # TemplateResponseDocumentFormFieldDropdown -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentFormFieldText` +* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentFormFieldRadio` +* Signature Field uses `TemplateResponseDocumentFormFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'dropdown'] | +| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md index ce0ff23b5..5cdfb577c 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md @@ -1,16 +1,25 @@ # # TemplateResponseDocumentFormFieldHyperlink -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentFormFieldText` +* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentFormFieldRadio` +* Signature Field uses `TemplateResponseDocumentFormFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'hyperlink'] | +| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_multiline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this form field is multiline text. REPLACE_ME_WITH_DESCRIPTION_END | | +| `original_font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Original font size used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | +| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md index ab0ccda06..c8263854f 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md @@ -1,12 +1,21 @@ # # TemplateResponseDocumentFormFieldInitials -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentFormFieldText` +* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentFormFieldRadio` +* Signature Field uses `TemplateResponseDocumentFormFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'initials'] | +| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md index 3b888caf7..f30ded2a7 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md @@ -1,12 +1,21 @@ # # TemplateResponseDocumentFormFieldRadio -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | -| `group`*_required_ | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentFormFieldText` +* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentFormFieldRadio` +* Signature Field uses `TemplateResponseDocumentFormFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'radio'] | +| `group`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md index b46f1d963..052cf942f 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md @@ -1,12 +1,21 @@ # # TemplateResponseDocumentFormFieldSignature -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentFormFieldText` +* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentFormFieldRadio` +* Signature Field uses `TemplateResponseDocumentFormFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'signature'] | +| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md index e6af0e041..034b62ee6 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md @@ -1,17 +1,26 @@ # # TemplateResponseDocumentFormFieldText -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | -| `validation_type` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentFormFieldText` +* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentFormFieldRadio` +* Signature Field uses `TemplateResponseDocumentFormFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | +| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_multiline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this form field is multiline text. REPLACE_ME_WITH_DESCRIPTION_END | | +| `original_font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Original font size used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | +| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | +| `validation_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. REPLACE_ME_WITH_DESCRIPTION_END | | +| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md index 3a7a044a4..e97fcf9b5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md @@ -6,15 +6,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | A unique id for the static field. | | -| `name` | ```string``` | The name of the static field. | | -| `signer` | ```string``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```int``` | The horizontal offset in pixels for this static field. | | -| `y` | ```int``` | The vertical offset in pixels for this static field. | | -| `width` | ```int``` | The width in pixels of this static field. | | -| `height` | ```int``` | The height in pixels of this static field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `api_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A unique id for the static field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the static field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signer` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The signer of the Static Field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'me_now'] | +| `x` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The horizontal offset in pixels for this static field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `y` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The vertical offset in pixels for this static field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `width` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The width in pixels of this static field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `height` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The height in pixels of this static field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean showing whether or not this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | +| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null`. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md index 4a23cb66b..6f430bc1d 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md @@ -1,11 +1,20 @@ # # TemplateResponseDocumentStaticFieldCheckbox -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'checkbox'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentStaticFieldText` +* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` +* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md index 9c9d86fb4..7e58405f4 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md @@ -1,11 +1,20 @@ # # TemplateResponseDocumentStaticFieldDateSigned -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'date_signed'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentStaticFieldText` +* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` +* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'date_signed'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md index d5cdc36da..4dbdedbd9 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md @@ -1,11 +1,20 @@ # # TemplateResponseDocumentStaticFieldDropdown -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'dropdown'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentStaticFieldText` +* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` +* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'dropdown'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md index 304d2e082..af2745fea 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md @@ -1,11 +1,20 @@ # # TemplateResponseDocumentStaticFieldHyperlink -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'hyperlink'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentStaticFieldText` +* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` +* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'hyperlink'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md index 9f112d1f3..a0f2f5ba2 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md @@ -1,11 +1,20 @@ # # TemplateResponseDocumentStaticFieldInitials -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'initials'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentStaticFieldText` +* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` +* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'initials'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md index 1225138aa..61b0135d9 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md @@ -1,11 +1,20 @@ # # TemplateResponseDocumentStaticFieldRadio -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'radio'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentStaticFieldText` +* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` +* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'radio'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md index 661b84cfd..d1b491e89 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md @@ -1,11 +1,20 @@ # # TemplateResponseDocumentStaticFieldSignature -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'signature'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentStaticFieldText` +* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` +* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'signature'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md index fa528fb68..0bf726f51 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md @@ -1,11 +1,20 @@ # # TemplateResponseDocumentStaticFieldText -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'text'] | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). + +* Text Field uses `TemplateResponseDocumentStaticFieldText` +* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` +* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` +* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` +* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` +* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` +* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` +* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md index b9db83c57..5d97074e4 100644 --- a/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md +++ b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md @@ -6,7 +6,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_lines` | ```int``` | Number of lines. | | -| `num_chars_per_line` | ```int``` | Number of characters per line. | | +| `num_lines` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of lines. REPLACE_ME_WITH_DESCRIPTION_END | | +| `num_chars_per_line` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of characters per line. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseSignerRole.md b/sdks/php/docs/Model/TemplateResponseSignerRole.md index fdf2f15d0..9f4346a43 100644 --- a/sdks/php/docs/Model/TemplateResponseSignerRole.md +++ b/sdks/php/docs/Model/TemplateResponseSignerRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | -| `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | +| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the Role. REPLACE_ME_WITH_DESCRIPTION_END | | +| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN If signer order is assigned this is the 0-based index for this role. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateUpdateFilesRequest.md b/sdks/php/docs/Model/TemplateUpdateFilesRequest.md index 322110dd6..c0054585a 100644 --- a/sdks/php/docs/Model/TemplateUpdateFilesRequest.md +++ b/sdks/php/docs/Model/TemplateUpdateFilesRequest.md @@ -6,11 +6,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id` | ```string``` | Client id of the app you're using to update this template. | | -| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to use for the template.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `message` | ```string``` | The new default template email message. | | -| `subject` | ```string``` | The new default template email subject. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to update this template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to use for the template. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The new default template email message. REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The new default template email subject. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateUpdateFilesResponse.md b/sdks/php/docs/Model/TemplateUpdateFilesResponse.md index 5d28cef0d..625f05899 100644 --- a/sdks/php/docs/Model/TemplateUpdateFilesResponse.md +++ b/sdks/php/docs/Model/TemplateUpdateFilesResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate```](TemplateUpdateFilesResponseTemplate.md) | | | +| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate```](TemplateUpdateFilesResponseTemplate.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md index b8fb3f5c2..241a18a0f 100644 --- a/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md @@ -6,7 +6,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `template_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md index 4d9b2c5c4..35c7ca139 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md @@ -6,41 +6,73 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | -| `requester_email_address`*_required_ | ```string``` | The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. | | -| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to true] | -| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | -| `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | -| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | -| `force_signer_page` | ```bool``` | Provide users the ability to review/edit the signers. | [default to false] | -| `force_subject_message` | ```bool``` | Provide users the ability to review/edit the subject and message. | [default to false] | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | -| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | -| `hide_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] | -| `hold_request` | ```bool``` | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] | -| `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] | -| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature. | | -| `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | -| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | -| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `skip_me_now` | ```bool``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | -| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `type` | ```string``` | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [default to 'request_signature'] | -| `use_preexisting_fields` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | -| `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | -| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | -| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | +| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `requester_email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_ccs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | +| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + +**NOTE:** Only available for Premium plan and higher. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | +| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email addresses that should be CCed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + +Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + +For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `force_signer_page` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the signers. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `force_subject_message` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the subject and message. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + +**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + +* Text Field use `SubFormFieldsPerDocumentText` +* Dropdown Field use `SubFormFieldsPerDocumentDropdown` +* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` +* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` +* Radio Field use `SubFormFieldsPerDocumentRadio` +* Signature Field use `SubFormFieldsPerDocumentSignature` +* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` +* Initials Field use `SubFormFieldsPerDocumentInitials` +* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` +* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | +| `hide_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `hold_request` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `is_for_embedded_signing` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `requesting_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully request a signature. REPLACE_ME_WITH_DESCRIPTION_END | | +| `show_preview` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the editor/preview experience. + +- `show_preview=true`: Allows requesters to enable the editor/preview experience. +- `show_preview=false`: Allows requesters to disable the editor/preview experience. REPLACE_ME_WITH_DESCRIPTION_END | | +| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | +| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Unclaimed Draft Signature Request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `skip_me_now` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'request_signature'] | +| `use_preexisting_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `use_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `populate_auto_fill_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. + +**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + +**NOTE:** This does not correspond to the **expires_at** returned in the response. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index 1d09deee9..3b4cffb04 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -6,35 +6,53 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | -| `requester_email_address`*_required_ | ```string``` | The email address of the user that should be designated as the requester of this draft. | | -| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. | | -| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | -| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | -| `files` | ```\SplFileObject[]``` | Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored.

**files** or **file_urls[]** is required, but not both. | | -| `file_urls` | ```string[]``` | Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored.

**files** or **file_urls[]** is required, but not both. | | -| `force_signer_roles` | ```bool``` | Provide users the ability to review/edit the template signer roles. | [default to false] | -| `force_subject_message` | ```bool``` | Provide users the ability to review/edit the template subject and message. | [default to false] | -| `hold_request` | ```bool``` | The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] | -| `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] | -| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `preview_only` | ```bool``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.

**NOTE:** This parameter overwrites `show_preview=1` (if set). | [default to false] | -| `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature. | | -| `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] | -| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner[]```](SubUnclaimedDraftTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | -| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `skip_me_now` | ```bool``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | -| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | -| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | -| `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to false] | +| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `requester_email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the user that should be designated as the requester of this draft. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_ids`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + +**NOTE:** Only available for Premium plan and higher. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add CC email recipients. Required when a CC role exists for the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array defining values and options for custom fields. Required when a custom field exists in the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. + +**files** or **file_urls[]** is required, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored. + +**files** or **file_urls[]** is required, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `force_signer_roles` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template signer roles. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `force_subject_message` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template subject and message. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `hold_request` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `is_for_embedded_signing` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `preview_only` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). + +- `preview_only=true`: Allows requesters to enable the preview only experience. +- `preview_only=false`: Allows requesters to disable the preview only experience. + +**NOTE:** This parameter overwrites `show_preview=1` (if set). REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `requesting_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully request a signature. REPLACE_ME_WITH_DESCRIPTION_END | | +| `show_preview` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the editor/preview experience. + +- `show_preview=true`: Allows requesters to enable the editor/preview experience. +- `show_preview=false`: Allows requesters to disable the editor/preview experience. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | +| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner[]```](SubUnclaimedDraftTemplateSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Templated-based Signature Request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `skip_me_now` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `populate_auto_fill_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. + +**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `allow_ccs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md index afcb4a779..cc149fca8 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md @@ -6,29 +6,54 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. | | -| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | -| `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | -| `client_id` | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | -| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | -| `hide_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] | -| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | -| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | -| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | -| `use_preexisting_fields` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | -| `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | -| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | +| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + +This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | +| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | +| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email addresses that should be CCed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + +Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + +For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + +**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + +* Text Field use `SubFormFieldsPerDocumentText` +* Dropdown Field use `SubFormFieldsPerDocumentDropdown` +* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` +* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` +* Radio Field use `SubFormFieldsPerDocumentRadio` +* Signature Field use `SubFormFieldsPerDocumentSignature` +* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` +* Initials Field use `SubFormFieldsPerDocumentInitials` +* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` +* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | +| `hide_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + +Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | +| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | +| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Unclaimed Draft Signature Request. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `use_preexisting_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `use_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + +**NOTE:** This does not correspond to the **expires_at** returned in the response. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md b/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md index 666b4ae1f..1d9e70ded 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `unclaimed_draft`*_required_ | [```\Dropbox\Sign\Model\UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `unclaimed_draft`*_required_ | [```\Dropbox\Sign\Model\UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftEditAndResendRequest.md b/sdks/php/docs/Model/UnclaimedDraftEditAndResendRequest.md index 2ff47860e..a1809b54d 100644 --- a/sdks/php/docs/Model/UnclaimedDraftEditAndResendRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftEditAndResendRequest.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | -| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | -| `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. | | -| `requester_email_address` | ```string``` | The email address of the user that should be designated as the requester of this draft. If not set, original requester's email address will be used. | | -| `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature. | | -| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | +| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `is_for_embedded_signing` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The request created from this draft will also be signable in embedded mode if set to `true`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `requester_email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the user that should be designated as the requester of this draft. If not set, original requester's email address will be used. REPLACE_ME_WITH_DESCRIPTION_END | | +| `requesting_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully request a signature. REPLACE_ME_WITH_DESCRIPTION_END | | +| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftResponse.md b/sdks/php/docs/Model/UnclaimedDraftResponse.md index 36989223b..2ec9a74e2 100644 --- a/sdks/php/docs/Model/UnclaimedDraftResponse.md +++ b/sdks/php/docs/Model/UnclaimedDraftResponse.md @@ -6,11 +6,11 @@ A group of documents that a user can take ownership of via the claim URL. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_request_id` | ```string``` | The ID of the signature request that is represented by this UnclaimedDraft. | | -| `claim_url` | ```string``` | The URL to be used to claim this UnclaimedDraft. | | -| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). | | -| `expires_at` | ```int``` | When the link expires. | | -| `test_mode` | ```bool``` | Whether this is a test draft. Signature requests made from test drafts have no legal value. | | +| `signature_request_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The ID of the signature request that is represented by this UnclaimedDraft. REPLACE_ME_WITH_DESCRIPTION_END | | +| `claim_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL to be used to claim this UnclaimedDraft. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `requesting_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). REPLACE_ME_WITH_DESCRIPTION_END | | +| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the link expires. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test draft. Signature requests made from test drafts have no legal value. REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/WarningResponse.md b/sdks/php/docs/Model/WarningResponse.md index 8bec8a324..869c23786 100644 --- a/sdks/php/docs/Model/WarningResponse.md +++ b/sdks/php/docs/Model/WarningResponse.md @@ -6,7 +6,7 @@ A list of warnings. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `warning_msg`*_required_ | ```string``` | Warning message | | -| `warning_name`*_required_ | ```string``` | Warning name | | +| `warning_msg`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Warning message REPLACE_ME_WITH_DESCRIPTION_END | | +| `warning_name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Warning name REPLACE_ME_WITH_DESCRIPTION_END | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/src/Api/AccountApi.php b/sdks/php/src/Api/AccountApi.php index cfdc96f11..c3a6717a1 100644 --- a/sdks/php/src/Api/AccountApi.php +++ b/sdks/php/src/Api/AccountApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,34 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; /** * AccountApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class AccountApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'accountCreate' => [ 'application/json', @@ -85,13 +92,16 @@ class AccountApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -105,7 +115,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -142,13 +152,13 @@ public function getResponse() * * Create Account * - * @param Model\AccountCreateRequest $account_create_request account_create_request (required) + * @param \Dropbox\Sign\Model\AccountCreateRequest $account_create_request account_create_request (required) * - * @return Model\AccountCreateResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\AccountCreateResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function accountCreate(Model\AccountCreateRequest $account_create_request) + public function accountCreate($account_create_request) { list($response) = $this->accountCreateWithHttpInfo($account_create_request); return $response; @@ -159,15 +169,15 @@ public function accountCreate(Model\AccountCreateRequest $account_create_request * * Create Account * - * @param Model\AccountCreateRequest $account_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountCreateRequest $account_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * - * @return array of Model\AccountCreateResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\AccountCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::accountCreate. This method will eventually become unavailable */ - public function accountCreateWithHttpInfo(Model\AccountCreateRequest $account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) + public function accountCreateWithHttpInfo($account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) { $request = $this->accountCreateRequest($account_create_request, $contentType); @@ -179,14 +189,14 @@ public function accountCreateWithHttpInfo(Model\AccountCreateRequest $account_cr } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -199,14 +209,14 @@ public function accountCreateWithHttpInfo(Model\AccountCreateRequest $account_cr sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -215,17 +225,18 @@ public function accountCreateWithHttpInfo(Model\AccountCreateRequest $account_cr if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\AccountCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\AccountCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -242,19 +253,20 @@ public function accountCreateWithHttpInfo(Model\AccountCreateRequest $account_cr return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\AccountCreateResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\AccountCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -271,9 +283,11 @@ public function accountCreateWithHttpInfo(Model\AccountCreateRequest $account_cr return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -286,6 +300,7 @@ public function accountCreateWithHttpInfo(Model\AccountCreateRequest $account_cr ); $e->setResponseObject($data); break; + } throw $e; } @@ -296,14 +311,14 @@ public function accountCreateWithHttpInfo(Model\AccountCreateRequest $account_cr * * Create Account * - * @param Model\AccountCreateRequest $account_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountCreateRequest $account_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::accountCreate. This method will eventually become unavailable */ - public function accountCreateAsync(Model\AccountCreateRequest $account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) + public function accountCreateAsync($account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) { return $this->accountCreateAsyncWithHttpInfo($account_create_request, $contentType) ->then( @@ -318,14 +333,14 @@ function ($response) { * * Create Account * - * @param Model\AccountCreateRequest $account_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountCreateRequest $account_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::accountCreate. This method will eventually become unavailable */ - public function accountCreateAsyncWithHttpInfo(Model\AccountCreateRequest $account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) + public function accountCreateAsyncWithHttpInfo($account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) { $returnType = '\Dropbox\Sign\Model\AccountCreateResponse'; $request = $this->accountCreateRequest($account_create_request, $contentType); @@ -335,9 +350,9 @@ public function accountCreateAsyncWithHttpInfo(Model\AccountCreateRequest $accou ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -346,7 +361,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -360,7 +375,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -369,22 +384,24 @@ function ($exception) { /** * Create request for operation 'accountCreate' * - * @param Model\AccountCreateRequest $account_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountCreateRequest $account_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::accountCreate. This method will eventually become unavailable */ - public function accountCreateRequest(Model\AccountCreateRequest $account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) + public function accountCreateRequest($account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) { + // verify the required parameter 'account_create_request' is set if ($account_create_request === null || (is_array($account_create_request) && count($account_create_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $account_create_request when calling accountCreate' ); } + $resourcePath = '/account/create'; $formParams = []; $queryParams = []; @@ -398,8 +415,11 @@ public function accountCreateRequest(Model\AccountCreateRequest $account_create_ $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -407,7 +427,7 @@ public function accountCreateRequest(Model\AccountCreateRequest $account_create_ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($account_create_request)); } else { $httpBody = $account_create_request; @@ -420,7 +440,7 @@ public function accountCreateRequest(Model\AccountCreateRequest $account_create_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -437,8 +457,9 @@ public function accountCreateRequest(Model\AccountCreateRequest $account_create_ $payloadHook('multipart', $multipartContents, $account_create_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -481,14 +502,14 @@ public function accountCreateRequest(Model\AccountCreateRequest $account_create_ * * Get Account * - * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) - * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) + * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) + * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) * - * @return Model\AccountGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\AccountGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function accountGet(string $account_id = null, string $email_address = null) + public function accountGet($account_id = null, $email_address = null) { list($response) = $this->accountGetWithHttpInfo($account_id, $email_address); return $response; @@ -499,16 +520,16 @@ public function accountGet(string $account_id = null, string $email_address = nu * * Get Account * - * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) - * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation + * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) + * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation * - * @return array of Model\AccountGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\AccountGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::accountGet. This method will eventually become unavailable */ - public function accountGetWithHttpInfo(string $account_id = null, string $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) + public function accountGetWithHttpInfo($account_id = null, $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) { $request = $this->accountGetRequest($account_id, $email_address, $contentType); @@ -520,14 +541,14 @@ public function accountGetWithHttpInfo(string $account_id = null, string $email_ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -540,14 +561,14 @@ public function accountGetWithHttpInfo(string $account_id = null, string $email_ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -556,17 +577,18 @@ public function accountGetWithHttpInfo(string $account_id = null, string $email_ if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\AccountGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\AccountGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -583,19 +605,20 @@ public function accountGetWithHttpInfo(string $account_id = null, string $email_ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\AccountGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\AccountGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -612,9 +635,11 @@ public function accountGetWithHttpInfo(string $account_id = null, string $email_ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -627,6 +652,7 @@ public function accountGetWithHttpInfo(string $account_id = null, string $email_ ); $e->setResponseObject($data); break; + } throw $e; } @@ -637,15 +663,15 @@ public function accountGetWithHttpInfo(string $account_id = null, string $email_ * * Get Account * - * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) - * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation + * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) + * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::accountGet. This method will eventually become unavailable */ - public function accountGetAsync(string $account_id = null, string $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) + public function accountGetAsync($account_id = null, $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) { return $this->accountGetAsyncWithHttpInfo($account_id, $email_address, $contentType) ->then( @@ -660,15 +686,15 @@ function ($response) { * * Get Account * - * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) - * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation + * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) + * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::accountGet. This method will eventually become unavailable */ - public function accountGetAsyncWithHttpInfo(string $account_id = null, string $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) + public function accountGetAsyncWithHttpInfo($account_id = null, $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) { $returnType = '\Dropbox\Sign\Model\AccountGetResponse'; $request = $this->accountGetRequest($account_id, $email_address, $contentType); @@ -678,9 +704,9 @@ public function accountGetAsyncWithHttpInfo(string $account_id = null, string $e ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -689,7 +715,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -703,7 +729,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -712,16 +738,20 @@ function ($exception) { /** * Create request for operation 'accountGet' * - * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) - * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation + * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) + * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::accountGet. This method will eventually become unavailable */ - public function accountGetRequest(string $account_id = null, string $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) + public function accountGetRequest($account_id = null, $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) { + + + + $resourcePath = '/account'; $formParams = []; $queryParams = []; @@ -748,8 +778,11 @@ public function accountGetRequest(string $account_id = null, string $email_addre false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -763,7 +796,7 @@ public function accountGetRequest(string $account_id = null, string $email_addre foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -777,8 +810,9 @@ public function accountGetRequest(string $account_id = null, string $email_addre } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -821,13 +855,13 @@ public function accountGetRequest(string $account_id = null, string $email_addre * * Update Account * - * @param Model\AccountUpdateRequest $account_update_request account_update_request (required) + * @param \Dropbox\Sign\Model\AccountUpdateRequest $account_update_request account_update_request (required) * - * @return Model\AccountGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\AccountGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function accountUpdate(Model\AccountUpdateRequest $account_update_request) + public function accountUpdate($account_update_request) { list($response) = $this->accountUpdateWithHttpInfo($account_update_request); return $response; @@ -838,15 +872,15 @@ public function accountUpdate(Model\AccountUpdateRequest $account_update_request * * Update Account * - * @param Model\AccountUpdateRequest $account_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountUpdateRequest $account_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * - * @return array of Model\AccountGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\AccountGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::accountUpdate. This method will eventually become unavailable */ - public function accountUpdateWithHttpInfo(Model\AccountUpdateRequest $account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) + public function accountUpdateWithHttpInfo($account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) { $request = $this->accountUpdateRequest($account_update_request, $contentType); @@ -858,14 +892,14 @@ public function accountUpdateWithHttpInfo(Model\AccountUpdateRequest $account_up } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -878,14 +912,14 @@ public function accountUpdateWithHttpInfo(Model\AccountUpdateRequest $account_up sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -894,17 +928,18 @@ public function accountUpdateWithHttpInfo(Model\AccountUpdateRequest $account_up if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\AccountGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\AccountGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -921,19 +956,20 @@ public function accountUpdateWithHttpInfo(Model\AccountUpdateRequest $account_up return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\AccountGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\AccountGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -950,9 +986,11 @@ public function accountUpdateWithHttpInfo(Model\AccountUpdateRequest $account_up return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -965,6 +1003,7 @@ public function accountUpdateWithHttpInfo(Model\AccountUpdateRequest $account_up ); $e->setResponseObject($data); break; + } throw $e; } @@ -975,14 +1014,14 @@ public function accountUpdateWithHttpInfo(Model\AccountUpdateRequest $account_up * * Update Account * - * @param Model\AccountUpdateRequest $account_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountUpdateRequest $account_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::accountUpdate. This method will eventually become unavailable */ - public function accountUpdateAsync(Model\AccountUpdateRequest $account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) + public function accountUpdateAsync($account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) { return $this->accountUpdateAsyncWithHttpInfo($account_update_request, $contentType) ->then( @@ -997,14 +1036,14 @@ function ($response) { * * Update Account * - * @param Model\AccountUpdateRequest $account_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountUpdateRequest $account_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::accountUpdate. This method will eventually become unavailable */ - public function accountUpdateAsyncWithHttpInfo(Model\AccountUpdateRequest $account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) + public function accountUpdateAsyncWithHttpInfo($account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) { $returnType = '\Dropbox\Sign\Model\AccountGetResponse'; $request = $this->accountUpdateRequest($account_update_request, $contentType); @@ -1014,9 +1053,9 @@ public function accountUpdateAsyncWithHttpInfo(Model\AccountUpdateRequest $accou ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1025,7 +1064,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1039,7 +1078,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1048,22 +1087,24 @@ function ($exception) { /** * Create request for operation 'accountUpdate' * - * @param Model\AccountUpdateRequest $account_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountUpdateRequest $account_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::accountUpdate. This method will eventually become unavailable */ - public function accountUpdateRequest(Model\AccountUpdateRequest $account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) + public function accountUpdateRequest($account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) { + // verify the required parameter 'account_update_request' is set if ($account_update_request === null || (is_array($account_update_request) && count($account_update_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $account_update_request when calling accountUpdate' ); } + $resourcePath = '/account'; $formParams = []; $queryParams = []; @@ -1077,8 +1118,11 @@ public function accountUpdateRequest(Model\AccountUpdateRequest $account_update_ $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1086,7 +1130,7 @@ public function accountUpdateRequest(Model\AccountUpdateRequest $account_update_ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($account_update_request)); } else { $httpBody = $account_update_request; @@ -1099,7 +1143,7 @@ public function accountUpdateRequest(Model\AccountUpdateRequest $account_update_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1116,8 +1160,9 @@ public function accountUpdateRequest(Model\AccountUpdateRequest $account_update_ $payloadHook('multipart', $multipartContents, $account_update_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1160,13 +1205,13 @@ public function accountUpdateRequest(Model\AccountUpdateRequest $account_update_ * * Verify Account * - * @param Model\AccountVerifyRequest $account_verify_request account_verify_request (required) + * @param \Dropbox\Sign\Model\AccountVerifyRequest $account_verify_request account_verify_request (required) * - * @return Model\AccountVerifyResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\AccountVerifyResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function accountVerify(Model\AccountVerifyRequest $account_verify_request) + public function accountVerify($account_verify_request) { list($response) = $this->accountVerifyWithHttpInfo($account_verify_request); return $response; @@ -1177,15 +1222,15 @@ public function accountVerify(Model\AccountVerifyRequest $account_verify_request * * Verify Account * - * @param Model\AccountVerifyRequest $account_verify_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountVerifyRequest $account_verify_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * - * @return array of Model\AccountVerifyResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\AccountVerifyResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::accountVerify. This method will eventually become unavailable */ - public function accountVerifyWithHttpInfo(Model\AccountVerifyRequest $account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) + public function accountVerifyWithHttpInfo($account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) { $request = $this->accountVerifyRequest($account_verify_request, $contentType); @@ -1197,14 +1242,14 @@ public function accountVerifyWithHttpInfo(Model\AccountVerifyRequest $account_ve } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1217,14 +1262,14 @@ public function accountVerifyWithHttpInfo(Model\AccountVerifyRequest $account_ve sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1233,17 +1278,18 @@ public function accountVerifyWithHttpInfo(Model\AccountVerifyRequest $account_ve if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\AccountVerifyResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\AccountVerifyResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1260,19 +1306,20 @@ public function accountVerifyWithHttpInfo(Model\AccountVerifyRequest $account_ve return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\AccountVerifyResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\AccountVerifyResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1289,9 +1336,11 @@ public function accountVerifyWithHttpInfo(Model\AccountVerifyRequest $account_ve return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1304,6 +1353,7 @@ public function accountVerifyWithHttpInfo(Model\AccountVerifyRequest $account_ve ); $e->setResponseObject($data); break; + } throw $e; } @@ -1314,14 +1364,14 @@ public function accountVerifyWithHttpInfo(Model\AccountVerifyRequest $account_ve * * Verify Account * - * @param Model\AccountVerifyRequest $account_verify_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountVerifyRequest $account_verify_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::accountVerify. This method will eventually become unavailable */ - public function accountVerifyAsync(Model\AccountVerifyRequest $account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) + public function accountVerifyAsync($account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) { return $this->accountVerifyAsyncWithHttpInfo($account_verify_request, $contentType) ->then( @@ -1336,14 +1386,14 @@ function ($response) { * * Verify Account * - * @param Model\AccountVerifyRequest $account_verify_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountVerifyRequest $account_verify_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::accountVerify. This method will eventually become unavailable */ - public function accountVerifyAsyncWithHttpInfo(Model\AccountVerifyRequest $account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) + public function accountVerifyAsyncWithHttpInfo($account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) { $returnType = '\Dropbox\Sign\Model\AccountVerifyResponse'; $request = $this->accountVerifyRequest($account_verify_request, $contentType); @@ -1353,9 +1403,9 @@ public function accountVerifyAsyncWithHttpInfo(Model\AccountVerifyRequest $accou ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1364,7 +1414,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1378,7 +1428,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1387,22 +1437,24 @@ function ($exception) { /** * Create request for operation 'accountVerify' * - * @param Model\AccountVerifyRequest $account_verify_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\AccountVerifyRequest $account_verify_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::accountVerify. This method will eventually become unavailable */ - public function accountVerifyRequest(Model\AccountVerifyRequest $account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) + public function accountVerifyRequest($account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) { + // verify the required parameter 'account_verify_request' is set if ($account_verify_request === null || (is_array($account_verify_request) && count($account_verify_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $account_verify_request when calling accountVerify' ); } + $resourcePath = '/account/verify'; $formParams = []; $queryParams = []; @@ -1416,8 +1468,11 @@ public function accountVerifyRequest(Model\AccountVerifyRequest $account_verify_ $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1425,7 +1480,7 @@ public function accountVerifyRequest(Model\AccountVerifyRequest $account_verify_ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($account_verify_request)); } else { $httpBody = $account_verify_request; @@ -1438,7 +1493,7 @@ public function accountVerifyRequest(Model\AccountVerifyRequest $account_verify_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1455,8 +1510,9 @@ public function accountVerifyRequest(Model\AccountVerifyRequest $account_verify_ $payloadHook('multipart', $multipartContents, $account_verify_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1497,8 +1553,8 @@ public function accountVerifyRequest(Model\AccountVerifyRequest $account_verify_ /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -1506,7 +1562,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -1522,8 +1578,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -1533,9 +1589,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -1554,8 +1610,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/ApiAppApi.php b/sdks/php/src/Api/ApiAppApi.php index 07dd3db63..f9d35ad11 100644 --- a/sdks/php/src/Api/ApiAppApi.php +++ b/sdks/php/src/Api/ApiAppApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,34 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; /** * ApiAppApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class ApiAppApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'apiAppCreate' => [ 'application/json', @@ -90,13 +97,16 @@ class ApiAppApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -110,7 +120,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -147,13 +157,13 @@ public function getResponse() * * Create API App * - * @param Model\ApiAppCreateRequest $api_app_create_request api_app_create_request (required) + * @param \Dropbox\Sign\Model\ApiAppCreateRequest $api_app_create_request api_app_create_request (required) * - * @return Model\ApiAppGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function apiAppCreate(Model\ApiAppCreateRequest $api_app_create_request) + public function apiAppCreate($api_app_create_request) { list($response) = $this->apiAppCreateWithHttpInfo($api_app_create_request); return $response; @@ -164,15 +174,15 @@ public function apiAppCreate(Model\ApiAppCreateRequest $api_app_create_request) * * Create API App * - * @param Model\ApiAppCreateRequest $api_app_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\ApiAppCreateRequest $api_app_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * - * @return array of Model\ApiAppGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::apiAppCreate. This method will eventually become unavailable */ - public function apiAppCreateWithHttpInfo(Model\ApiAppCreateRequest $api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) + public function apiAppCreateWithHttpInfo($api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) { $request = $this->apiAppCreateRequest($api_app_create_request, $contentType); @@ -184,14 +194,14 @@ public function apiAppCreateWithHttpInfo(Model\ApiAppCreateRequest $api_app_crea } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -204,14 +214,14 @@ public function apiAppCreateWithHttpInfo(Model\ApiAppCreateRequest $api_app_crea sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -220,17 +230,18 @@ public function apiAppCreateWithHttpInfo(Model\ApiAppCreateRequest $api_app_crea if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 201: if ('\Dropbox\Sign\Model\ApiAppGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\ApiAppGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -247,19 +258,20 @@ public function apiAppCreateWithHttpInfo(Model\ApiAppCreateRequest $api_app_crea return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\ApiAppGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -276,9 +288,11 @@ public function apiAppCreateWithHttpInfo(Model\ApiAppCreateRequest $api_app_crea return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -291,6 +305,7 @@ public function apiAppCreateWithHttpInfo(Model\ApiAppCreateRequest $api_app_crea ); $e->setResponseObject($data); break; + } throw $e; } @@ -301,14 +316,14 @@ public function apiAppCreateWithHttpInfo(Model\ApiAppCreateRequest $api_app_crea * * Create API App * - * @param Model\ApiAppCreateRequest $api_app_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\ApiAppCreateRequest $api_app_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppCreate. This method will eventually become unavailable */ - public function apiAppCreateAsync(Model\ApiAppCreateRequest $api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) + public function apiAppCreateAsync($api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) { return $this->apiAppCreateAsyncWithHttpInfo($api_app_create_request, $contentType) ->then( @@ -323,14 +338,14 @@ function ($response) { * * Create API App * - * @param Model\ApiAppCreateRequest $api_app_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\ApiAppCreateRequest $api_app_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppCreate. This method will eventually become unavailable */ - public function apiAppCreateAsyncWithHttpInfo(Model\ApiAppCreateRequest $api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) + public function apiAppCreateAsyncWithHttpInfo($api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) { $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; $request = $this->apiAppCreateRequest($api_app_create_request, $contentType); @@ -340,9 +355,9 @@ public function apiAppCreateAsyncWithHttpInfo(Model\ApiAppCreateRequest $api_app ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -351,7 +366,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -365,7 +380,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -374,22 +389,24 @@ function ($exception) { /** * Create request for operation 'apiAppCreate' * - * @param Model\ApiAppCreateRequest $api_app_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\ApiAppCreateRequest $api_app_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::apiAppCreate. This method will eventually become unavailable */ - public function apiAppCreateRequest(Model\ApiAppCreateRequest $api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) + public function apiAppCreateRequest($api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) { + // verify the required parameter 'api_app_create_request' is set if ($api_app_create_request === null || (is_array($api_app_create_request) && count($api_app_create_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $api_app_create_request when calling apiAppCreate' ); } + $resourcePath = '/api_app'; $formParams = []; $queryParams = []; @@ -403,8 +420,11 @@ public function apiAppCreateRequest(Model\ApiAppCreateRequest $api_app_create_re $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -412,7 +432,7 @@ public function apiAppCreateRequest(Model\ApiAppCreateRequest $api_app_create_re // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($api_app_create_request)); } else { $httpBody = $api_app_create_request; @@ -425,7 +445,7 @@ public function apiAppCreateRequest(Model\ApiAppCreateRequest $api_app_create_re foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -442,8 +462,9 @@ public function apiAppCreateRequest(Model\ApiAppCreateRequest $api_app_create_re $payloadHook('multipart', $multipartContents, $api_app_create_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -486,12 +507,13 @@ public function apiAppCreateRequest(Model\ApiAppCreateRequest $api_app_create_re * * Delete API App * - * @param string $client_id The client id of the API App to delete. (required) + * @param string $client_id The client id of the API App to delete. (required) * - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return void */ - public function apiAppDelete(string $client_id) + public function apiAppDelete($client_id) { $this->apiAppDeleteWithHttpInfo($client_id); } @@ -501,15 +523,15 @@ public function apiAppDelete(string $client_id) * * Delete API App * - * @param string $client_id The client id of the API App to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation + * @param string $client_id The client id of the API App to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppDelete. This method will eventually become unavailable */ - public function apiAppDeleteWithHttpInfo(string $client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) + public function apiAppDeleteWithHttpInfo($client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) { $request = $this->apiAppDeleteRequest($client_id, $contentType); @@ -521,14 +543,14 @@ public function apiAppDeleteWithHttpInfo(string $client_id, string $contentType } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -541,20 +563,23 @@ public function apiAppDeleteWithHttpInfo(string $client_id, string $contentType sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { + } throw $e; } @@ -565,14 +590,14 @@ public function apiAppDeleteWithHttpInfo(string $client_id, string $contentType * * Delete API App * - * @param string $client_id The client id of the API App to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation + * @param string $client_id The client id of the API App to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppDelete. This method will eventually become unavailable */ - public function apiAppDeleteAsync(string $client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) + public function apiAppDeleteAsync($client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) { return $this->apiAppDeleteAsyncWithHttpInfo($client_id, $contentType) ->then( @@ -587,14 +612,14 @@ function ($response) { * * Delete API App * - * @param string $client_id The client id of the API App to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation + * @param string $client_id The client id of the API App to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppDelete. This method will eventually become unavailable */ - public function apiAppDeleteAsyncWithHttpInfo(string $client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) + public function apiAppDeleteAsyncWithHttpInfo($client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) { $returnType = ''; $request = $this->apiAppDeleteRequest($client_id, $contentType); @@ -602,7 +627,7 @@ public function apiAppDeleteAsyncWithHttpInfo(string $client_id, string $content return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) { + function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -616,7 +641,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -625,22 +650,24 @@ function ($exception) { /** * Create request for operation 'apiAppDelete' * - * @param string $client_id The client id of the API App to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation + * @param string $client_id The client id of the API App to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::apiAppDelete. This method will eventually become unavailable */ - public function apiAppDeleteRequest(string $client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) + public function apiAppDeleteRequest($client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) { + // verify the required parameter 'client_id' is set if ($client_id === null || (is_array($client_id) && count($client_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $client_id when calling apiAppDelete' ); } + $resourcePath = '/api_app/{client_id}'; $formParams = []; $queryParams = []; @@ -648,17 +675,20 @@ public function apiAppDeleteRequest(string $client_id, string $contentType = sel $httpBody = ''; $multipart = false; + + // path params if ($client_id !== null) { $resourcePath = str_replace( - '{client_id}', + '{' . 'client_id' . '}', ObjectSerializer::toPathValue($client_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -672,7 +702,7 @@ public function apiAppDeleteRequest(string $client_id, string $contentType = sel foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -686,8 +716,9 @@ public function apiAppDeleteRequest(string $client_id, string $contentType = sel } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -730,13 +761,13 @@ public function apiAppDeleteRequest(string $client_id, string $contentType = sel * * Get API App * - * @param string $client_id The client id of the API App to retrieve. (required) + * @param string $client_id The client id of the API App to retrieve. (required) * - * @return Model\ApiAppGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function apiAppGet(string $client_id) + public function apiAppGet($client_id) { list($response) = $this->apiAppGetWithHttpInfo($client_id); return $response; @@ -747,15 +778,15 @@ public function apiAppGet(string $client_id) * * Get API App * - * @param string $client_id The client id of the API App to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation + * @param string $client_id The client id of the API App to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * - * @return array of Model\ApiAppGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::apiAppGet. This method will eventually become unavailable */ - public function apiAppGetWithHttpInfo(string $client_id, string $contentType = self::contentTypes['apiAppGet'][0]) + public function apiAppGetWithHttpInfo($client_id, string $contentType = self::contentTypes['apiAppGet'][0]) { $request = $this->apiAppGetRequest($client_id, $contentType); @@ -767,14 +798,14 @@ public function apiAppGetWithHttpInfo(string $client_id, string $contentType = s } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -787,14 +818,14 @@ public function apiAppGetWithHttpInfo(string $client_id, string $contentType = s sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -803,17 +834,18 @@ public function apiAppGetWithHttpInfo(string $client_id, string $contentType = s if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\ApiAppGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\ApiAppGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -830,19 +862,20 @@ public function apiAppGetWithHttpInfo(string $client_id, string $contentType = s return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\ApiAppGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -859,9 +892,11 @@ public function apiAppGetWithHttpInfo(string $client_id, string $contentType = s return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -874,6 +909,7 @@ public function apiAppGetWithHttpInfo(string $client_id, string $contentType = s ); $e->setResponseObject($data); break; + } throw $e; } @@ -884,14 +920,14 @@ public function apiAppGetWithHttpInfo(string $client_id, string $contentType = s * * Get API App * - * @param string $client_id The client id of the API App to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation + * @param string $client_id The client id of the API App to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppGet. This method will eventually become unavailable */ - public function apiAppGetAsync(string $client_id, string $contentType = self::contentTypes['apiAppGet'][0]) + public function apiAppGetAsync($client_id, string $contentType = self::contentTypes['apiAppGet'][0]) { return $this->apiAppGetAsyncWithHttpInfo($client_id, $contentType) ->then( @@ -906,14 +942,14 @@ function ($response) { * * Get API App * - * @param string $client_id The client id of the API App to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation + * @param string $client_id The client id of the API App to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppGet. This method will eventually become unavailable */ - public function apiAppGetAsyncWithHttpInfo(string $client_id, string $contentType = self::contentTypes['apiAppGet'][0]) + public function apiAppGetAsyncWithHttpInfo($client_id, string $contentType = self::contentTypes['apiAppGet'][0]) { $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; $request = $this->apiAppGetRequest($client_id, $contentType); @@ -923,9 +959,9 @@ public function apiAppGetAsyncWithHttpInfo(string $client_id, string $contentTyp ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -934,7 +970,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -948,7 +984,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -957,22 +993,24 @@ function ($exception) { /** * Create request for operation 'apiAppGet' * - * @param string $client_id The client id of the API App to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation + * @param string $client_id The client id of the API App to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::apiAppGet. This method will eventually become unavailable */ - public function apiAppGetRequest(string $client_id, string $contentType = self::contentTypes['apiAppGet'][0]) + public function apiAppGetRequest($client_id, string $contentType = self::contentTypes['apiAppGet'][0]) { + // verify the required parameter 'client_id' is set if ($client_id === null || (is_array($client_id) && count($client_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $client_id when calling apiAppGet' ); } + $resourcePath = '/api_app/{client_id}'; $formParams = []; $queryParams = []; @@ -980,17 +1018,20 @@ public function apiAppGetRequest(string $client_id, string $contentType = self:: $httpBody = ''; $multipart = false; + + // path params if ($client_id !== null) { $resourcePath = str_replace( - '{client_id}', + '{' . 'client_id' . '}', ObjectSerializer::toPathValue($client_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1004,7 +1045,7 @@ public function apiAppGetRequest(string $client_id, string $contentType = self:: foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1018,8 +1059,9 @@ public function apiAppGetRequest(string $client_id, string $contentType = self:: } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1062,14 +1104,14 @@ public function apiAppGetRequest(string $client_id, string $contentType = self:: * * List API Apps * - * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * - * @return Model\ApiAppListResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\ApiAppListResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function apiAppList(int $page = 1, int $page_size = 20) + public function apiAppList($page = 1, $page_size = 20) { list($response) = $this->apiAppListWithHttpInfo($page, $page_size); return $response; @@ -1080,16 +1122,16 @@ public function apiAppList(int $page = 1, int $page_size = 20) * * List API Apps * - * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation + * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation * - * @return array of Model\ApiAppListResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\ApiAppListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::apiAppList. This method will eventually become unavailable */ - public function apiAppListWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) + public function apiAppListWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) { $request = $this->apiAppListRequest($page, $page_size, $contentType); @@ -1101,14 +1143,14 @@ public function apiAppListWithHttpInfo(int $page = 1, int $page_size = 20, strin } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1121,14 +1163,14 @@ public function apiAppListWithHttpInfo(int $page = 1, int $page_size = 20, strin sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1137,17 +1179,18 @@ public function apiAppListWithHttpInfo(int $page = 1, int $page_size = 20, strin if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\ApiAppListResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\ApiAppListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1164,19 +1207,20 @@ public function apiAppListWithHttpInfo(int $page = 1, int $page_size = 20, strin return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\ApiAppListResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\ApiAppListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1193,9 +1237,11 @@ public function apiAppListWithHttpInfo(int $page = 1, int $page_size = 20, strin return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1208,6 +1254,7 @@ public function apiAppListWithHttpInfo(int $page = 1, int $page_size = 20, strin ); $e->setResponseObject($data); break; + } throw $e; } @@ -1218,15 +1265,15 @@ public function apiAppListWithHttpInfo(int $page = 1, int $page_size = 20, strin * * List API Apps * - * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation + * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppList. This method will eventually become unavailable */ - public function apiAppListAsync(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) + public function apiAppListAsync($page = 1, $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) { return $this->apiAppListAsyncWithHttpInfo($page, $page_size, $contentType) ->then( @@ -1241,15 +1288,15 @@ function ($response) { * * List API Apps * - * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation + * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppList. This method will eventually become unavailable */ - public function apiAppListAsyncWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) + public function apiAppListAsyncWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) { $returnType = '\Dropbox\Sign\Model\ApiAppListResponse'; $request = $this->apiAppListRequest($page, $page_size, $contentType); @@ -1259,9 +1306,9 @@ public function apiAppListAsyncWithHttpInfo(int $page = 1, int $page_size = 20, ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1270,7 +1317,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1284,7 +1331,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1293,16 +1340,20 @@ function ($exception) { /** * Create request for operation 'apiAppList' * - * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation + * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::apiAppList. This method will eventually become unavailable */ - public function apiAppListRequest(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) + public function apiAppListRequest($page = 1, $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) { + + + + $resourcePath = '/api_app/list'; $formParams = []; $queryParams = []; @@ -1329,8 +1380,11 @@ public function apiAppListRequest(int $page = 1, int $page_size = 20, string $co false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1344,7 +1398,7 @@ public function apiAppListRequest(int $page = 1, int $page_size = 20, string $co foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1358,8 +1412,9 @@ public function apiAppListRequest(int $page = 1, int $page_size = 20, string $co } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1402,14 +1457,14 @@ public function apiAppListRequest(int $page = 1, int $page_size = 20, string $co * * Update API App * - * @param string $client_id The client id of the API App to update. (required) - * @param Model\ApiAppUpdateRequest $api_app_update_request api_app_update_request (required) + * @param string $client_id The client id of the API App to update. (required) + * @param \Dropbox\Sign\Model\ApiAppUpdateRequest $api_app_update_request api_app_update_request (required) * - * @return Model\ApiAppGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function apiAppUpdate(string $client_id, Model\ApiAppUpdateRequest $api_app_update_request) + public function apiAppUpdate($client_id, $api_app_update_request) { list($response) = $this->apiAppUpdateWithHttpInfo($client_id, $api_app_update_request); return $response; @@ -1420,16 +1475,16 @@ public function apiAppUpdate(string $client_id, Model\ApiAppUpdateRequest $api_a * * Update API App * - * @param string $client_id The client id of the API App to update. (required) - * @param Model\ApiAppUpdateRequest $api_app_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation + * @param string $client_id The client id of the API App to update. (required) + * @param \Dropbox\Sign\Model\ApiAppUpdateRequest $api_app_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation * - * @return array of Model\ApiAppGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::apiAppUpdate. This method will eventually become unavailable */ - public function apiAppUpdateWithHttpInfo(string $client_id, Model\ApiAppUpdateRequest $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) + public function apiAppUpdateWithHttpInfo($client_id, $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) { $request = $this->apiAppUpdateRequest($client_id, $api_app_update_request, $contentType); @@ -1441,14 +1496,14 @@ public function apiAppUpdateWithHttpInfo(string $client_id, Model\ApiAppUpdateRe } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1461,14 +1516,14 @@ public function apiAppUpdateWithHttpInfo(string $client_id, Model\ApiAppUpdateRe sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1477,17 +1532,18 @@ public function apiAppUpdateWithHttpInfo(string $client_id, Model\ApiAppUpdateRe if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\ApiAppGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\ApiAppGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1504,19 +1560,20 @@ public function apiAppUpdateWithHttpInfo(string $client_id, Model\ApiAppUpdateRe return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\ApiAppGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1533,9 +1590,11 @@ public function apiAppUpdateWithHttpInfo(string $client_id, Model\ApiAppUpdateRe return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1548,6 +1607,7 @@ public function apiAppUpdateWithHttpInfo(string $client_id, Model\ApiAppUpdateRe ); $e->setResponseObject($data); break; + } throw $e; } @@ -1558,15 +1618,15 @@ public function apiAppUpdateWithHttpInfo(string $client_id, Model\ApiAppUpdateRe * * Update API App * - * @param string $client_id The client id of the API App to update. (required) - * @param Model\ApiAppUpdateRequest $api_app_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation + * @param string $client_id The client id of the API App to update. (required) + * @param \Dropbox\Sign\Model\ApiAppUpdateRequest $api_app_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppUpdate. This method will eventually become unavailable */ - public function apiAppUpdateAsync(string $client_id, Model\ApiAppUpdateRequest $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) + public function apiAppUpdateAsync($client_id, $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) { return $this->apiAppUpdateAsyncWithHttpInfo($client_id, $api_app_update_request, $contentType) ->then( @@ -1581,15 +1641,15 @@ function ($response) { * * Update API App * - * @param string $client_id The client id of the API App to update. (required) - * @param Model\ApiAppUpdateRequest $api_app_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation + * @param string $client_id The client id of the API App to update. (required) + * @param \Dropbox\Sign\Model\ApiAppUpdateRequest $api_app_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppUpdate. This method will eventually become unavailable */ - public function apiAppUpdateAsyncWithHttpInfo(string $client_id, Model\ApiAppUpdateRequest $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) + public function apiAppUpdateAsyncWithHttpInfo($client_id, $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) { $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; $request = $this->apiAppUpdateRequest($client_id, $api_app_update_request, $contentType); @@ -1599,9 +1659,9 @@ public function apiAppUpdateAsyncWithHttpInfo(string $client_id, Model\ApiAppUpd ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1610,7 +1670,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1624,7 +1684,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1633,30 +1693,32 @@ function ($exception) { /** * Create request for operation 'apiAppUpdate' * - * @param string $client_id The client id of the API App to update. (required) - * @param Model\ApiAppUpdateRequest $api_app_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation + * @param string $client_id The client id of the API App to update. (required) + * @param \Dropbox\Sign\Model\ApiAppUpdateRequest $api_app_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::apiAppUpdate. This method will eventually become unavailable */ - public function apiAppUpdateRequest(string $client_id, Model\ApiAppUpdateRequest $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) + public function apiAppUpdateRequest($client_id, $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) { + // verify the required parameter 'client_id' is set if ($client_id === null || (is_array($client_id) && count($client_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $client_id when calling apiAppUpdate' ); } // verify the required parameter 'api_app_update_request' is set if ($api_app_update_request === null || (is_array($api_app_update_request) && count($api_app_update_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $api_app_update_request when calling apiAppUpdate' ); } + $resourcePath = '/api_app/{client_id}'; $formParams = []; $queryParams = []; @@ -1670,17 +1732,19 @@ public function apiAppUpdateRequest(string $client_id, Model\ApiAppUpdateRequest $multipart = !empty($formParams); + // path params if ($client_id !== null) { $resourcePath = str_replace( - '{client_id}', + '{' . 'client_id' . '}', ObjectSerializer::toPathValue($client_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1688,7 +1752,7 @@ public function apiAppUpdateRequest(string $client_id, Model\ApiAppUpdateRequest // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($api_app_update_request)); } else { $httpBody = $api_app_update_request; @@ -1701,7 +1765,7 @@ public function apiAppUpdateRequest(string $client_id, Model\ApiAppUpdateRequest foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1718,8 +1782,9 @@ public function apiAppUpdateRequest(string $client_id, Model\ApiAppUpdateRequest $payloadHook('multipart', $multipartContents, $api_app_update_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1760,8 +1825,8 @@ public function apiAppUpdateRequest(string $client_id, Model\ApiAppUpdateRequest /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -1769,7 +1834,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -1785,8 +1850,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -1796,9 +1861,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -1817,8 +1882,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/BulkSendJobApi.php b/sdks/php/src/Api/BulkSendJobApi.php index 77ad055c7..3a95c799b 100644 --- a/sdks/php/src/Api/BulkSendJobApi.php +++ b/sdks/php/src/Api/BulkSendJobApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,34 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; /** * BulkSendJobApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class BulkSendJobApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'bulkSendJobGet' => [ 'application/json', @@ -79,13 +86,16 @@ class BulkSendJobApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -99,7 +109,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -136,15 +146,15 @@ public function getResponse() * * Get Bulk Send Job * - * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) - * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) + * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * - * @return Model\BulkSendJobGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\BulkSendJobGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function bulkSendJobGet(string $bulk_send_job_id, int $page = 1, int $page_size = 20) + public function bulkSendJobGet($bulk_send_job_id, $page = 1, $page_size = 20) { list($response) = $this->bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page, $page_size); return $response; @@ -155,17 +165,17 @@ public function bulkSendJobGet(string $bulk_send_job_id, int $page = 1, int $pag * * Get Bulk Send Job * - * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) - * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation + * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) + * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation * - * @return array of Model\BulkSendJobGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\BulkSendJobGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::bulkSendJobGet. This method will eventually become unavailable */ - public function bulkSendJobGetWithHttpInfo(string $bulk_send_job_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) + public function bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) { $request = $this->bulkSendJobGetRequest($bulk_send_job_id, $page, $page_size, $contentType); @@ -177,14 +187,14 @@ public function bulkSendJobGetWithHttpInfo(string $bulk_send_job_id, int $page = } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -197,14 +207,14 @@ public function bulkSendJobGetWithHttpInfo(string $bulk_send_job_id, int $page = sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -213,17 +223,18 @@ public function bulkSendJobGetWithHttpInfo(string $bulk_send_job_id, int $page = if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\BulkSendJobGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\BulkSendJobGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -240,19 +251,20 @@ public function bulkSendJobGetWithHttpInfo(string $bulk_send_job_id, int $page = return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\BulkSendJobGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\BulkSendJobGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -269,9 +281,11 @@ public function bulkSendJobGetWithHttpInfo(string $bulk_send_job_id, int $page = return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -284,6 +298,7 @@ public function bulkSendJobGetWithHttpInfo(string $bulk_send_job_id, int $page = ); $e->setResponseObject($data); break; + } throw $e; } @@ -294,16 +309,16 @@ public function bulkSendJobGetWithHttpInfo(string $bulk_send_job_id, int $page = * * Get Bulk Send Job * - * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) - * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation + * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) + * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobGet. This method will eventually become unavailable */ - public function bulkSendJobGetAsync(string $bulk_send_job_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) + public function bulkSendJobGetAsync($bulk_send_job_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) { return $this->bulkSendJobGetAsyncWithHttpInfo($bulk_send_job_id, $page, $page_size, $contentType) ->then( @@ -318,16 +333,16 @@ function ($response) { * * Get Bulk Send Job * - * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) - * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation + * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) + * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobGet. This method will eventually become unavailable */ - public function bulkSendJobGetAsyncWithHttpInfo(string $bulk_send_job_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) + public function bulkSendJobGetAsyncWithHttpInfo($bulk_send_job_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) { $returnType = '\Dropbox\Sign\Model\BulkSendJobGetResponse'; $request = $this->bulkSendJobGetRequest($bulk_send_job_id, $page, $page_size, $contentType); @@ -337,9 +352,9 @@ public function bulkSendJobGetAsyncWithHttpInfo(string $bulk_send_job_id, int $p ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -348,7 +363,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -362,7 +377,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -371,24 +386,28 @@ function ($exception) { /** * Create request for operation 'bulkSendJobGet' * - * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) - * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation + * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) + * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::bulkSendJobGet. This method will eventually become unavailable */ - public function bulkSendJobGetRequest(string $bulk_send_job_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) + public function bulkSendJobGetRequest($bulk_send_job_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) { + // verify the required parameter 'bulk_send_job_id' is set if ($bulk_send_job_id === null || (is_array($bulk_send_job_id) && count($bulk_send_job_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $bulk_send_job_id when calling bulkSendJobGet' ); } + + + $resourcePath = '/bulk_send_job/{bulk_send_job_id}'; $formParams = []; $queryParams = []; @@ -415,17 +434,19 @@ public function bulkSendJobGetRequest(string $bulk_send_job_id, int $page = 1, i false // required ) ?? []); + // path params if ($bulk_send_job_id !== null) { $resourcePath = str_replace( - '{bulk_send_job_id}', + '{' . 'bulk_send_job_id' . '}', ObjectSerializer::toPathValue($bulk_send_job_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -439,7 +460,7 @@ public function bulkSendJobGetRequest(string $bulk_send_job_id, int $page = 1, i foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -453,8 +474,9 @@ public function bulkSendJobGetRequest(string $bulk_send_job_id, int $page = 1, i } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -497,14 +519,14 @@ public function bulkSendJobGetRequest(string $bulk_send_job_id, int $page = 1, i * * List Bulk Send Jobs * - * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * - * @return Model\BulkSendJobListResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\BulkSendJobListResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function bulkSendJobList(int $page = 1, int $page_size = 20) + public function bulkSendJobList($page = 1, $page_size = 20) { list($response) = $this->bulkSendJobListWithHttpInfo($page, $page_size); return $response; @@ -515,16 +537,16 @@ public function bulkSendJobList(int $page = 1, int $page_size = 20) * * List Bulk Send Jobs * - * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation + * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation * - * @return array of Model\BulkSendJobListResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\BulkSendJobListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::bulkSendJobList. This method will eventually become unavailable */ - public function bulkSendJobListWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) + public function bulkSendJobListWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) { $request = $this->bulkSendJobListRequest($page, $page_size, $contentType); @@ -536,14 +558,14 @@ public function bulkSendJobListWithHttpInfo(int $page = 1, int $page_size = 20, } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -556,14 +578,14 @@ public function bulkSendJobListWithHttpInfo(int $page = 1, int $page_size = 20, sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -572,17 +594,18 @@ public function bulkSendJobListWithHttpInfo(int $page = 1, int $page_size = 20, if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\BulkSendJobListResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\BulkSendJobListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -599,19 +622,20 @@ public function bulkSendJobListWithHttpInfo(int $page = 1, int $page_size = 20, return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\BulkSendJobListResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\BulkSendJobListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -628,9 +652,11 @@ public function bulkSendJobListWithHttpInfo(int $page = 1, int $page_size = 20, return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -643,6 +669,7 @@ public function bulkSendJobListWithHttpInfo(int $page = 1, int $page_size = 20, ); $e->setResponseObject($data); break; + } throw $e; } @@ -653,15 +680,15 @@ public function bulkSendJobListWithHttpInfo(int $page = 1, int $page_size = 20, * * List Bulk Send Jobs * - * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation + * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobList. This method will eventually become unavailable */ - public function bulkSendJobListAsync(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) + public function bulkSendJobListAsync($page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) { return $this->bulkSendJobListAsyncWithHttpInfo($page, $page_size, $contentType) ->then( @@ -676,15 +703,15 @@ function ($response) { * * List Bulk Send Jobs * - * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation + * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobList. This method will eventually become unavailable */ - public function bulkSendJobListAsyncWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) + public function bulkSendJobListAsyncWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) { $returnType = '\Dropbox\Sign\Model\BulkSendJobListResponse'; $request = $this->bulkSendJobListRequest($page, $page_size, $contentType); @@ -694,9 +721,9 @@ public function bulkSendJobListAsyncWithHttpInfo(int $page = 1, int $page_size = ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -705,7 +732,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -719,7 +746,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -728,16 +755,20 @@ function ($exception) { /** * Create request for operation 'bulkSendJobList' * - * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation + * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::bulkSendJobList. This method will eventually become unavailable */ - public function bulkSendJobListRequest(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) + public function bulkSendJobListRequest($page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) { + + + + $resourcePath = '/bulk_send_job/list'; $formParams = []; $queryParams = []; @@ -764,8 +795,11 @@ public function bulkSendJobListRequest(int $page = 1, int $page_size = 20, strin false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -779,7 +813,7 @@ public function bulkSendJobListRequest(int $page = 1, int $page_size = 20, strin foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -793,8 +827,9 @@ public function bulkSendJobListRequest(int $page = 1, int $page_size = 20, strin } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -835,8 +870,8 @@ public function bulkSendJobListRequest(int $page = 1, int $page_size = 20, strin /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -844,7 +879,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -860,8 +895,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -871,9 +906,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -892,8 +927,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/EmbeddedApi.php b/sdks/php/src/Api/EmbeddedApi.php index 364e5f7e7..baa672d7d 100644 --- a/sdks/php/src/Api/EmbeddedApi.php +++ b/sdks/php/src/Api/EmbeddedApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,34 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; /** * EmbeddedApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class EmbeddedApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'embeddedEditUrl' => [ 'application/json', @@ -79,13 +86,16 @@ class EmbeddedApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -99,7 +109,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -136,14 +146,14 @@ public function getResponse() * * Get Embedded Template Edit URL * - * @param string $template_id The id of the template to edit. (required) - * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request embedded_edit_url_request (required) + * @param string $template_id The id of the template to edit. (required) + * @param \Dropbox\Sign\Model\EmbeddedEditUrlRequest $embedded_edit_url_request embedded_edit_url_request (required) * - * @return Model\EmbeddedEditUrlResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\EmbeddedEditUrlResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function embeddedEditUrl(string $template_id, Model\EmbeddedEditUrlRequest $embedded_edit_url_request) + public function embeddedEditUrl($template_id, $embedded_edit_url_request) { list($response) = $this->embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_request); return $response; @@ -154,16 +164,16 @@ public function embeddedEditUrl(string $template_id, Model\EmbeddedEditUrlReques * * Get Embedded Template Edit URL * - * @param string $template_id The id of the template to edit. (required) - * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation + * @param string $template_id The id of the template to edit. (required) + * @param \Dropbox\Sign\Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation * - * @return array of Model\EmbeddedEditUrlResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\EmbeddedEditUrlResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::embeddedEditUrl. This method will eventually become unavailable */ - public function embeddedEditUrlWithHttpInfo(string $template_id, Model\EmbeddedEditUrlRequest $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) + public function embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) { $request = $this->embeddedEditUrlRequest($template_id, $embedded_edit_url_request, $contentType); @@ -175,14 +185,14 @@ public function embeddedEditUrlWithHttpInfo(string $template_id, Model\EmbeddedE } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -195,14 +205,14 @@ public function embeddedEditUrlWithHttpInfo(string $template_id, Model\EmbeddedE sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -211,17 +221,18 @@ public function embeddedEditUrlWithHttpInfo(string $template_id, Model\EmbeddedE if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\EmbeddedEditUrlResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\EmbeddedEditUrlResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -238,19 +249,20 @@ public function embeddedEditUrlWithHttpInfo(string $template_id, Model\EmbeddedE return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\EmbeddedEditUrlResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\EmbeddedEditUrlResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -267,9 +279,11 @@ public function embeddedEditUrlWithHttpInfo(string $template_id, Model\EmbeddedE return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -282,6 +296,7 @@ public function embeddedEditUrlWithHttpInfo(string $template_id, Model\EmbeddedE ); $e->setResponseObject($data); break; + } throw $e; } @@ -292,15 +307,15 @@ public function embeddedEditUrlWithHttpInfo(string $template_id, Model\EmbeddedE * * Get Embedded Template Edit URL * - * @param string $template_id The id of the template to edit. (required) - * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation + * @param string $template_id The id of the template to edit. (required) + * @param \Dropbox\Sign\Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedEditUrl. This method will eventually become unavailable */ - public function embeddedEditUrlAsync(string $template_id, Model\EmbeddedEditUrlRequest $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) + public function embeddedEditUrlAsync($template_id, $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) { return $this->embeddedEditUrlAsyncWithHttpInfo($template_id, $embedded_edit_url_request, $contentType) ->then( @@ -315,15 +330,15 @@ function ($response) { * * Get Embedded Template Edit URL * - * @param string $template_id The id of the template to edit. (required) - * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation + * @param string $template_id The id of the template to edit. (required) + * @param \Dropbox\Sign\Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedEditUrl. This method will eventually become unavailable */ - public function embeddedEditUrlAsyncWithHttpInfo(string $template_id, Model\EmbeddedEditUrlRequest $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) + public function embeddedEditUrlAsyncWithHttpInfo($template_id, $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) { $returnType = '\Dropbox\Sign\Model\EmbeddedEditUrlResponse'; $request = $this->embeddedEditUrlRequest($template_id, $embedded_edit_url_request, $contentType); @@ -333,9 +348,9 @@ public function embeddedEditUrlAsyncWithHttpInfo(string $template_id, Model\Embe ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -344,7 +359,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -358,7 +373,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -367,30 +382,32 @@ function ($exception) { /** * Create request for operation 'embeddedEditUrl' * - * @param string $template_id The id of the template to edit. (required) - * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation + * @param string $template_id The id of the template to edit. (required) + * @param \Dropbox\Sign\Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::embeddedEditUrl. This method will eventually become unavailable */ - public function embeddedEditUrlRequest(string $template_id, Model\EmbeddedEditUrlRequest $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) + public function embeddedEditUrlRequest($template_id, $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) { + // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_id when calling embeddedEditUrl' ); } // verify the required parameter 'embedded_edit_url_request' is set if ($embedded_edit_url_request === null || (is_array($embedded_edit_url_request) && count($embedded_edit_url_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $embedded_edit_url_request when calling embeddedEditUrl' ); } + $resourcePath = '/embedded/edit_url/{template_id}'; $formParams = []; $queryParams = []; @@ -404,17 +421,19 @@ public function embeddedEditUrlRequest(string $template_id, Model\EmbeddedEditUr $multipart = !empty($formParams); + // path params if ($template_id !== null) { $resourcePath = str_replace( - '{template_id}', + '{' . 'template_id' . '}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -422,7 +441,7 @@ public function embeddedEditUrlRequest(string $template_id, Model\EmbeddedEditUr // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($embedded_edit_url_request)); } else { $httpBody = $embedded_edit_url_request; @@ -435,7 +454,7 @@ public function embeddedEditUrlRequest(string $template_id, Model\EmbeddedEditUr foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -452,8 +471,9 @@ public function embeddedEditUrlRequest(string $template_id, Model\EmbeddedEditUr $payloadHook('multipart', $multipartContents, $embedded_edit_url_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -496,13 +516,13 @@ public function embeddedEditUrlRequest(string $template_id, Model\EmbeddedEditUr * * Get Embedded Sign URL * - * @param string $signature_id The id of the signature to get a signature url for. (required) + * @param string $signature_id The id of the signature to get a signature url for. (required) * - * @return Model\EmbeddedSignUrlResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\EmbeddedSignUrlResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function embeddedSignUrl(string $signature_id) + public function embeddedSignUrl($signature_id) { list($response) = $this->embeddedSignUrlWithHttpInfo($signature_id); return $response; @@ -513,15 +533,15 @@ public function embeddedSignUrl(string $signature_id) * * Get Embedded Sign URL * - * @param string $signature_id The id of the signature to get a signature url for. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation + * @param string $signature_id The id of the signature to get a signature url for. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * - * @return array of Model\EmbeddedSignUrlResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\EmbeddedSignUrlResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::embeddedSignUrl. This method will eventually become unavailable */ - public function embeddedSignUrlWithHttpInfo(string $signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) + public function embeddedSignUrlWithHttpInfo($signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) { $request = $this->embeddedSignUrlRequest($signature_id, $contentType); @@ -533,14 +553,14 @@ public function embeddedSignUrlWithHttpInfo(string $signature_id, string $conten } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -553,14 +573,14 @@ public function embeddedSignUrlWithHttpInfo(string $signature_id, string $conten sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -569,17 +589,18 @@ public function embeddedSignUrlWithHttpInfo(string $signature_id, string $conten if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\EmbeddedSignUrlResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\EmbeddedSignUrlResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -596,19 +617,20 @@ public function embeddedSignUrlWithHttpInfo(string $signature_id, string $conten return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\EmbeddedSignUrlResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\EmbeddedSignUrlResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -625,9 +647,11 @@ public function embeddedSignUrlWithHttpInfo(string $signature_id, string $conten return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -640,6 +664,7 @@ public function embeddedSignUrlWithHttpInfo(string $signature_id, string $conten ); $e->setResponseObject($data); break; + } throw $e; } @@ -650,14 +675,14 @@ public function embeddedSignUrlWithHttpInfo(string $signature_id, string $conten * * Get Embedded Sign URL * - * @param string $signature_id The id of the signature to get a signature url for. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation + * @param string $signature_id The id of the signature to get a signature url for. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedSignUrl. This method will eventually become unavailable */ - public function embeddedSignUrlAsync(string $signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) + public function embeddedSignUrlAsync($signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) { return $this->embeddedSignUrlAsyncWithHttpInfo($signature_id, $contentType) ->then( @@ -672,14 +697,14 @@ function ($response) { * * Get Embedded Sign URL * - * @param string $signature_id The id of the signature to get a signature url for. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation + * @param string $signature_id The id of the signature to get a signature url for. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedSignUrl. This method will eventually become unavailable */ - public function embeddedSignUrlAsyncWithHttpInfo(string $signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) + public function embeddedSignUrlAsyncWithHttpInfo($signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) { $returnType = '\Dropbox\Sign\Model\EmbeddedSignUrlResponse'; $request = $this->embeddedSignUrlRequest($signature_id, $contentType); @@ -689,9 +714,9 @@ public function embeddedSignUrlAsyncWithHttpInfo(string $signature_id, string $c ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -700,7 +725,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -714,7 +739,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -723,22 +748,24 @@ function ($exception) { /** * Create request for operation 'embeddedSignUrl' * - * @param string $signature_id The id of the signature to get a signature url for. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation + * @param string $signature_id The id of the signature to get a signature url for. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::embeddedSignUrl. This method will eventually become unavailable */ - public function embeddedSignUrlRequest(string $signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) + public function embeddedSignUrlRequest($signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) { + // verify the required parameter 'signature_id' is set if ($signature_id === null || (is_array($signature_id) && count($signature_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_id when calling embeddedSignUrl' ); } + $resourcePath = '/embedded/sign_url/{signature_id}'; $formParams = []; $queryParams = []; @@ -746,17 +773,20 @@ public function embeddedSignUrlRequest(string $signature_id, string $contentType $httpBody = ''; $multipart = false; + + // path params if ($signature_id !== null) { $resourcePath = str_replace( - '{signature_id}', + '{' . 'signature_id' . '}', ObjectSerializer::toPathValue($signature_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -770,7 +800,7 @@ public function embeddedSignUrlRequest(string $signature_id, string $contentType foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -784,8 +814,9 @@ public function embeddedSignUrlRequest(string $signature_id, string $contentType } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -826,8 +857,8 @@ public function embeddedSignUrlRequest(string $signature_id, string $contentType /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -835,7 +866,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -851,8 +882,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -862,9 +893,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -883,8 +914,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/FaxApi.php b/sdks/php/src/Api/FaxApi.php index 619778c5b..194b3e3e6 100644 --- a/sdks/php/src/Api/FaxApi.php +++ b/sdks/php/src/Api/FaxApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,35 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; -use SplFileObject; /** * FaxApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class FaxApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'faxDelete' => [ 'application/json', @@ -90,13 +96,16 @@ class FaxApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -110,7 +119,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -147,12 +156,13 @@ public function getResponse() * * Delete Fax * - * @param string $fax_id Fax ID (required) + * @param string $fax_id Fax ID (required) * - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return void */ - public function faxDelete(string $fax_id) + public function faxDelete($fax_id) { $this->faxDeleteWithHttpInfo($fax_id); } @@ -162,15 +172,15 @@ public function faxDelete(string $fax_id) * * Delete Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable */ - public function faxDeleteWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + public function faxDeleteWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxDelete'][0]) { $request = $this->faxDeleteRequest($fax_id, $contentType); @@ -182,14 +192,14 @@ public function faxDeleteWithHttpInfo(string $fax_id, string $contentType = self } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -202,20 +212,23 @@ public function faxDeleteWithHttpInfo(string $fax_id, string $contentType = self sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { + } throw $e; } @@ -226,14 +239,14 @@ public function faxDeleteWithHttpInfo(string $fax_id, string $contentType = self * * Delete Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable */ - public function faxDeleteAsync(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + public function faxDeleteAsync($fax_id, string $contentType = self::contentTypes['faxDelete'][0]) { return $this->faxDeleteAsyncWithHttpInfo($fax_id, $contentType) ->then( @@ -248,14 +261,14 @@ function ($response) { * * Delete Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable */ - public function faxDeleteAsyncWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + public function faxDeleteAsyncWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxDelete'][0]) { $returnType = ''; $request = $this->faxDeleteRequest($fax_id, $contentType); @@ -263,7 +276,7 @@ public function faxDeleteAsyncWithHttpInfo(string $fax_id, string $contentType = return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) { + function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -277,7 +290,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -286,22 +299,24 @@ function ($exception) { /** * Create request for operation 'faxDelete' * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable */ - public function faxDeleteRequest(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + public function faxDeleteRequest($fax_id, string $contentType = self::contentTypes['faxDelete'][0]) { + // verify the required parameter 'fax_id' is set if ($fax_id === null || (is_array($fax_id) && count($fax_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $fax_id when calling faxDelete' ); } + $resourcePath = '/fax/{fax_id}'; $formParams = []; $queryParams = []; @@ -309,17 +324,20 @@ public function faxDeleteRequest(string $fax_id, string $contentType = self::con $httpBody = ''; $multipart = false; + + // path params if ($fax_id !== null) { $resourcePath = str_replace( - '{fax_id}', + '{' . 'fax_id' . '}', ObjectSerializer::toPathValue($fax_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -333,7 +351,7 @@ public function faxDeleteRequest(string $fax_id, string $contentType = self::con foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -347,8 +365,9 @@ public function faxDeleteRequest(string $fax_id, string $contentType = self::con } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -387,13 +406,13 @@ public function faxDeleteRequest(string $fax_id, string $contentType = self::con * * Download Fax Files * - * @param string $fax_id Fax ID (required) + * @param string $fax_id Fax ID (required) * - * @return SplFileObject - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \SplFileObject|\Dropbox\Sign\Model\ErrorResponse */ - public function faxFiles(string $fax_id) + public function faxFiles($fax_id) { list($response) = $this->faxFilesWithHttpInfo($fax_id); return $response; @@ -404,15 +423,15 @@ public function faxFiles(string $fax_id) * * Download Fax Files * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException * @return array of \SplFileObject|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable */ - public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + public function faxFilesWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxFiles'][0]) { $request = $this->faxFilesRequest($fax_id, $contentType); @@ -424,14 +443,14 @@ public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self: } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -444,14 +463,14 @@ public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self: sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -460,17 +479,18 @@ public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self: if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\SplFileObject' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\SplFileObject' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -487,19 +507,20 @@ public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self: return [ ObjectSerializer::deserialize($content, '\SplFileObject', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\SplFileObject'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -516,9 +537,11 @@ public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self: return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -531,6 +554,7 @@ public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self: ); $e->setResponseObject($data); break; + } throw $e; } @@ -541,14 +565,14 @@ public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self: * * Download Fax Files * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable */ - public function faxFilesAsync(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + public function faxFilesAsync($fax_id, string $contentType = self::contentTypes['faxFiles'][0]) { return $this->faxFilesAsyncWithHttpInfo($fax_id, $contentType) ->then( @@ -563,14 +587,14 @@ function ($response) { * * Download Fax Files * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable */ - public function faxFilesAsyncWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + public function faxFilesAsyncWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxFiles'][0]) { $returnType = '\SplFileObject'; $request = $this->faxFilesRequest($fax_id, $contentType); @@ -580,9 +604,9 @@ public function faxFilesAsyncWithHttpInfo(string $fax_id, string $contentType = ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -591,7 +615,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -605,7 +629,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -614,22 +638,24 @@ function ($exception) { /** * Create request for operation 'faxFiles' * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable */ - public function faxFilesRequest(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + public function faxFilesRequest($fax_id, string $contentType = self::contentTypes['faxFiles'][0]) { + // verify the required parameter 'fax_id' is set if ($fax_id === null || (is_array($fax_id) && count($fax_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $fax_id when calling faxFiles' ); } + $resourcePath = '/fax/files/{fax_id}'; $formParams = []; $queryParams = []; @@ -637,17 +663,20 @@ public function faxFilesRequest(string $fax_id, string $contentType = self::cont $httpBody = ''; $multipart = false; + + // path params if ($fax_id !== null) { $resourcePath = str_replace( - '{fax_id}', + '{' . 'fax_id' . '}', ObjectSerializer::toPathValue($fax_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/json'], + $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/json', ], $contentType, $multipart ); @@ -661,7 +690,7 @@ public function faxFilesRequest(string $fax_id, string $contentType = self::cont foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -675,8 +704,9 @@ public function faxFilesRequest(string $fax_id, string $contentType = self::cont } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -715,13 +745,13 @@ public function faxFilesRequest(string $fax_id, string $contentType = self::cont * * Get Fax * - * @param string $fax_id Fax ID (required) + * @param string $fax_id Fax ID (required) * - * @return Model\FaxGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FaxGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function faxGet(string $fax_id) + public function faxGet($fax_id) { list($response) = $this->faxGetWithHttpInfo($fax_id); return $response; @@ -732,15 +762,15 @@ public function faxGet(string $fax_id) * * Get Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * - * @return array of Model\FaxGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FaxGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable */ - public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) + public function faxGetWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxGet'][0]) { $request = $this->faxGetRequest($fax_id, $contentType); @@ -752,14 +782,14 @@ public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::c } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -772,14 +802,14 @@ public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::c sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -788,17 +818,18 @@ public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::c if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FaxGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -815,19 +846,20 @@ public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::c return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -844,9 +876,11 @@ public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::c return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -859,6 +893,7 @@ public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::c ); $e->setResponseObject($data); break; + } throw $e; } @@ -869,14 +904,14 @@ public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::c * * Get Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable */ - public function faxGetAsync(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) + public function faxGetAsync($fax_id, string $contentType = self::contentTypes['faxGet'][0]) { return $this->faxGetAsyncWithHttpInfo($fax_id, $contentType) ->then( @@ -891,14 +926,14 @@ function ($response) { * * Get Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable */ - public function faxGetAsyncWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) + public function faxGetAsyncWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxGet'][0]) { $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; $request = $this->faxGetRequest($fax_id, $contentType); @@ -908,9 +943,9 @@ public function faxGetAsyncWithHttpInfo(string $fax_id, string $contentType = se ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -919,7 +954,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -933,7 +968,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -942,22 +977,24 @@ function ($exception) { /** * Create request for operation 'faxGet' * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable */ - public function faxGetRequest(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) + public function faxGetRequest($fax_id, string $contentType = self::contentTypes['faxGet'][0]) { + // verify the required parameter 'fax_id' is set if ($fax_id === null || (is_array($fax_id) && count($fax_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $fax_id when calling faxGet' ); } + $resourcePath = '/fax/{fax_id}'; $formParams = []; $queryParams = []; @@ -965,17 +1002,20 @@ public function faxGetRequest(string $fax_id, string $contentType = self::conten $httpBody = ''; $multipart = false; + + // path params if ($fax_id !== null) { $resourcePath = str_replace( - '{fax_id}', + '{' . 'fax_id' . '}', ObjectSerializer::toPathValue($fax_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -989,7 +1029,7 @@ public function faxGetRequest(string $fax_id, string $contentType = self::conten foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1003,8 +1043,9 @@ public function faxGetRequest(string $fax_id, string $contentType = self::conten } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1043,14 +1084,14 @@ public function faxGetRequest(string $fax_id, string $contentType = self::conten * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * - * @return Model\FaxListResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FaxListResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function faxList(int $page = 1, int $page_size = 20) + public function faxList($page = 1, $page_size = 20) { list($response) = $this->faxListWithHttpInfo($page, $page_size); return $response; @@ -1061,16 +1102,16 @@ public function faxList(int $page = 1, int $page_size = 20) * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * - * @return array of Model\FaxListResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FaxListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::faxList. This method will eventually become unavailable */ - public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + public function faxListWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) { $request = $this->faxListRequest($page, $page_size, $contentType); @@ -1082,14 +1123,14 @@ public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1102,14 +1143,14 @@ public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1118,17 +1159,18 @@ public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $ if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxListResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FaxListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1145,19 +1187,20 @@ public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxListResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FaxListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1174,9 +1217,11 @@ public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1189,6 +1234,7 @@ public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $ ); $e->setResponseObject($data); break; + } throw $e; } @@ -1199,15 +1245,15 @@ public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $ * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxList. This method will eventually become unavailable */ - public function faxListAsync(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + public function faxListAsync($page = 1, $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) { return $this->faxListAsyncWithHttpInfo($page, $page_size, $contentType) ->then( @@ -1222,15 +1268,15 @@ function ($response) { * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxList. This method will eventually become unavailable */ - public function faxListAsyncWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + public function faxListAsyncWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) { $returnType = '\Dropbox\Sign\Model\FaxListResponse'; $request = $this->faxListRequest($page, $page_size, $contentType); @@ -1240,9 +1286,9 @@ public function faxListAsyncWithHttpInfo(int $page = 1, int $page_size = 20, str ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1251,7 +1297,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1265,7 +1311,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1274,26 +1320,28 @@ function ($exception) { /** * Create request for operation 'faxList' * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxList. This method will eventually become unavailable */ - public function faxListRequest(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + public function faxListRequest($page = 1, $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) { + if ($page !== null && $page < 1) { - throw new InvalidArgumentException('invalid value for "$page" when calling FaxApi.faxList, must be bigger than or equal to 1.'); + throw new \InvalidArgumentException('invalid value for "$page" when calling FaxApi.faxList, must be bigger than or equal to 1.'); } - + if ($page_size !== null && $page_size > 100) { - throw new InvalidArgumentException('invalid value for "$page_size" when calling FaxApi.faxList, must be smaller than or equal to 100.'); + throw new \InvalidArgumentException('invalid value for "$page_size" when calling FaxApi.faxList, must be smaller than or equal to 100.'); } if ($page_size !== null && $page_size < 1) { - throw new InvalidArgumentException('invalid value for "$page_size" when calling FaxApi.faxList, must be bigger than or equal to 1.'); + throw new \InvalidArgumentException('invalid value for "$page_size" when calling FaxApi.faxList, must be bigger than or equal to 1.'); } + $resourcePath = '/fax/list'; $formParams = []; @@ -1321,8 +1369,11 @@ public function faxListRequest(int $page = 1, int $page_size = 20, string $conte false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1336,7 +1387,7 @@ public function faxListRequest(int $page = 1, int $page_size = 20, string $conte foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1350,8 +1401,9 @@ public function faxListRequest(int $page = 1, int $page_size = 20, string $conte } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1390,13 +1442,13 @@ public function faxListRequest(int $page = 1, int $page_size = 20, string $conte * * Send Fax * - * @param Model\FaxSendRequest $fax_send_request fax_send_request (required) + * @param \Dropbox\Sign\Model\FaxSendRequest $fax_send_request fax_send_request (required) * - * @return Model\FaxGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FaxGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function faxSend(Model\FaxSendRequest $fax_send_request) + public function faxSend($fax_send_request) { list($response) = $this->faxSendWithHttpInfo($fax_send_request); return $response; @@ -1407,15 +1459,15 @@ public function faxSend(Model\FaxSendRequest $fax_send_request) * * Send Fax * - * @param Model\FaxSendRequest $fax_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * - * @return array of Model\FaxGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FaxGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable */ - public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + public function faxSendWithHttpInfo($fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) { $request = $this->faxSendRequest($fax_send_request, $contentType); @@ -1427,14 +1479,14 @@ public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, stri } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1447,14 +1499,14 @@ public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, stri sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1463,17 +1515,18 @@ public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, stri if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FaxGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1490,19 +1543,20 @@ public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, stri return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1519,9 +1573,11 @@ public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, stri return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1534,6 +1590,7 @@ public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, stri ); $e->setResponseObject($data); break; + } throw $e; } @@ -1544,14 +1601,14 @@ public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, stri * * Send Fax * - * @param Model\FaxSendRequest $fax_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable */ - public function faxSendAsync(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + public function faxSendAsync($fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) { return $this->faxSendAsyncWithHttpInfo($fax_send_request, $contentType) ->then( @@ -1566,14 +1623,14 @@ function ($response) { * * Send Fax * - * @param Model\FaxSendRequest $fax_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable */ - public function faxSendAsyncWithHttpInfo(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + public function faxSendAsyncWithHttpInfo($fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) { $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; $request = $this->faxSendRequest($fax_send_request, $contentType); @@ -1583,9 +1640,9 @@ public function faxSendAsyncWithHttpInfo(Model\FaxSendRequest $fax_send_request, ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1594,7 +1651,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1608,7 +1665,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1617,22 +1674,24 @@ function ($exception) { /** * Create request for operation 'faxSend' * - * @param Model\FaxSendRequest $fax_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable */ - public function faxSendRequest(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + public function faxSendRequest($fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) { + // verify the required parameter 'fax_send_request' is set if ($fax_send_request === null || (is_array($fax_send_request) && count($fax_send_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $fax_send_request when calling faxSend' ); } + $resourcePath = '/fax/send'; $formParams = []; $queryParams = []; @@ -1646,8 +1705,11 @@ public function faxSendRequest(Model\FaxSendRequest $fax_send_request, string $c $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1655,7 +1717,7 @@ public function faxSendRequest(Model\FaxSendRequest $fax_send_request, string $c // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_send_request)); } else { $httpBody = $fax_send_request; @@ -1668,7 +1730,7 @@ public function faxSendRequest(Model\FaxSendRequest $fax_send_request, string $c foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1685,8 +1747,9 @@ public function faxSendRequest(Model\FaxSendRequest $fax_send_request, string $c $payloadHook('multipart', $multipartContents, $fax_send_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1723,8 +1786,8 @@ public function faxSendRequest(Model\FaxSendRequest $fax_send_request, string $c /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -1732,7 +1795,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -1748,8 +1811,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -1759,9 +1822,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -1780,8 +1843,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/FaxLineApi.php b/sdks/php/src/Api/FaxLineApi.php index 65cefff54..4055af748 100644 --- a/sdks/php/src/Api/FaxLineApi.php +++ b/sdks/php/src/Api/FaxLineApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,34 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; /** * FaxLineApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class FaxLineApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'faxLineAddUser' => [ 'application/json', @@ -94,13 +101,16 @@ class FaxLineApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -114,7 +124,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -151,13 +161,13 @@ public function getResponse() * * Add Fax Line User * - * @param Model\FaxLineAddUserRequest $fax_line_add_user_request fax_line_add_user_request (required) + * @param \Dropbox\Sign\Model\FaxLineAddUserRequest $fax_line_add_user_request fax_line_add_user_request (required) * - * @return Model\FaxLineResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function faxLineAddUser(Model\FaxLineAddUserRequest $fax_line_add_user_request) + public function faxLineAddUser($fax_line_add_user_request) { list($response) = $this->faxLineAddUserWithHttpInfo($fax_line_add_user_request); return $response; @@ -168,15 +178,15 @@ public function faxLineAddUser(Model\FaxLineAddUserRequest $fax_line_add_user_re * * Add Fax Line User * - * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineAddUserRequest $fax_line_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * - * @return array of Model\FaxLineResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::faxLineAddUser. This method will eventually become unavailable */ - public function faxLineAddUserWithHttpInfo(Model\FaxLineAddUserRequest $fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) + public function faxLineAddUserWithHttpInfo($fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) { $request = $this->faxLineAddUserRequest($fax_line_add_user_request, $contentType); @@ -188,14 +198,14 @@ public function faxLineAddUserWithHttpInfo(Model\FaxLineAddUserRequest $fax_line } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -208,14 +218,14 @@ public function faxLineAddUserWithHttpInfo(Model\FaxLineAddUserRequest $fax_line sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -224,17 +234,18 @@ public function faxLineAddUserWithHttpInfo(Model\FaxLineAddUserRequest $fax_line if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FaxLineResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -251,19 +262,20 @@ public function faxLineAddUserWithHttpInfo(Model\FaxLineAddUserRequest $fax_line return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -280,9 +292,11 @@ public function faxLineAddUserWithHttpInfo(Model\FaxLineAddUserRequest $fax_line return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -295,6 +309,7 @@ public function faxLineAddUserWithHttpInfo(Model\FaxLineAddUserRequest $fax_line ); $e->setResponseObject($data); break; + } throw $e; } @@ -305,14 +320,14 @@ public function faxLineAddUserWithHttpInfo(Model\FaxLineAddUserRequest $fax_line * * Add Fax Line User * - * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineAddUserRequest $fax_line_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAddUser. This method will eventually become unavailable */ - public function faxLineAddUserAsync(Model\FaxLineAddUserRequest $fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) + public function faxLineAddUserAsync($fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) { return $this->faxLineAddUserAsyncWithHttpInfo($fax_line_add_user_request, $contentType) ->then( @@ -327,14 +342,14 @@ function ($response) { * * Add Fax Line User * - * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineAddUserRequest $fax_line_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAddUser. This method will eventually become unavailable */ - public function faxLineAddUserAsyncWithHttpInfo(Model\FaxLineAddUserRequest $fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) + public function faxLineAddUserAsyncWithHttpInfo($fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; $request = $this->faxLineAddUserRequest($fax_line_add_user_request, $contentType); @@ -344,9 +359,9 @@ public function faxLineAddUserAsyncWithHttpInfo(Model\FaxLineAddUserRequest $fax ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -355,7 +370,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -369,7 +384,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -378,22 +393,24 @@ function ($exception) { /** * Create request for operation 'faxLineAddUser' * - * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineAddUserRequest $fax_line_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxLineAddUser. This method will eventually become unavailable */ - public function faxLineAddUserRequest(Model\FaxLineAddUserRequest $fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) + public function faxLineAddUserRequest($fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) { + // verify the required parameter 'fax_line_add_user_request' is set if ($fax_line_add_user_request === null || (is_array($fax_line_add_user_request) && count($fax_line_add_user_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $fax_line_add_user_request when calling faxLineAddUser' ); } + $resourcePath = '/fax_line/add_user'; $formParams = []; $queryParams = []; @@ -407,8 +424,11 @@ public function faxLineAddUserRequest(Model\FaxLineAddUserRequest $fax_line_add_ $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -416,7 +436,7 @@ public function faxLineAddUserRequest(Model\FaxLineAddUserRequest $fax_line_add_ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_line_add_user_request)); } else { $httpBody = $fax_line_add_user_request; @@ -429,7 +449,7 @@ public function faxLineAddUserRequest(Model\FaxLineAddUserRequest $fax_line_add_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -446,8 +466,9 @@ public function faxLineAddUserRequest(Model\FaxLineAddUserRequest $fax_line_add_ $payloadHook('multipart', $multipartContents, $fax_line_add_user_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -486,16 +507,16 @@ public function faxLineAddUserRequest(Model\FaxLineAddUserRequest $fax_line_add_ * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * - * @return Model\FaxLineAreaCodeGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FaxLineAreaCodeGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function faxLineAreaCodeGet(string $country, string $state = null, string $province = null, string $city = null) + public function faxLineAreaCodeGet($country, $state = null, $province = null, $city = null) { list($response) = $this->faxLineAreaCodeGetWithHttpInfo($country, $state, $province, $city); return $response; @@ -506,18 +527,18 @@ public function faxLineAreaCodeGet(string $country, string $state = null, string * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * - * @return array of Model\FaxLineAreaCodeGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FaxLineAreaCodeGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::faxLineAreaCodeGet. This method will eventually become unavailable */ - public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = null, string $province = null, string $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) + public function faxLineAreaCodeGetWithHttpInfo($country, $state = null, $province = null, $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) { $request = $this->faxLineAreaCodeGetRequest($country, $state, $province, $city, $contentType); @@ -529,14 +550,14 @@ public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -549,14 +570,14 @@ public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -565,17 +586,18 @@ public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -592,19 +614,20 @@ public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -621,9 +644,11 @@ public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -636,6 +661,7 @@ public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = ); $e->setResponseObject($data); break; + } throw $e; } @@ -646,17 +672,17 @@ public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAreaCodeGet. This method will eventually become unavailable */ - public function faxLineAreaCodeGetAsync(string $country, string $state = null, string $province = null, string $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) + public function faxLineAreaCodeGetAsync($country, $state = null, $province = null, $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) { return $this->faxLineAreaCodeGetAsyncWithHttpInfo($country, $state, $province, $city, $contentType) ->then( @@ -671,17 +697,17 @@ function ($response) { * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAreaCodeGet. This method will eventually become unavailable */ - public function faxLineAreaCodeGetAsyncWithHttpInfo(string $country, string $state = null, string $province = null, string $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) + public function faxLineAreaCodeGetAsyncWithHttpInfo($country, $state = null, $province = null, $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse'; $request = $this->faxLineAreaCodeGetRequest($country, $state, $province, $city, $contentType); @@ -691,9 +717,9 @@ public function faxLineAreaCodeGetAsyncWithHttpInfo(string $country, string $sta ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -702,7 +728,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -716,7 +742,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -725,25 +751,30 @@ function ($exception) { /** * Create request for operation 'faxLineAreaCodeGet' * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxLineAreaCodeGet. This method will eventually become unavailable */ - public function faxLineAreaCodeGetRequest(string $country, string $state = null, string $province = null, string $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) + public function faxLineAreaCodeGetRequest($country, $state = null, $province = null, $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) { + // verify the required parameter 'country' is set if ($country === null || (is_array($country) && count($country) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $country when calling faxLineAreaCodeGet' ); } + + + + $resourcePath = '/fax_line/area_codes'; $formParams = []; $queryParams = []; @@ -788,8 +819,11 @@ public function faxLineAreaCodeGetRequest(string $country, string $state = null, false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -803,7 +837,7 @@ public function faxLineAreaCodeGetRequest(string $country, string $state = null, foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -817,8 +851,9 @@ public function faxLineAreaCodeGetRequest(string $country, string $state = null, } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -857,13 +892,13 @@ public function faxLineAreaCodeGetRequest(string $country, string $state = null, * * Purchase Fax Line * - * @param Model\FaxLineCreateRequest $fax_line_create_request fax_line_create_request (required) + * @param \Dropbox\Sign\Model\FaxLineCreateRequest $fax_line_create_request fax_line_create_request (required) * - * @return Model\FaxLineResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function faxLineCreate(Model\FaxLineCreateRequest $fax_line_create_request) + public function faxLineCreate($fax_line_create_request) { list($response) = $this->faxLineCreateWithHttpInfo($fax_line_create_request); return $response; @@ -874,15 +909,15 @@ public function faxLineCreate(Model\FaxLineCreateRequest $fax_line_create_reques * * Purchase Fax Line * - * @param Model\FaxLineCreateRequest $fax_line_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineCreateRequest $fax_line_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * - * @return array of Model\FaxLineResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::faxLineCreate. This method will eventually become unavailable */ - public function faxLineCreateWithHttpInfo(Model\FaxLineCreateRequest $fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) + public function faxLineCreateWithHttpInfo($fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) { $request = $this->faxLineCreateRequest($fax_line_create_request, $contentType); @@ -894,14 +929,14 @@ public function faxLineCreateWithHttpInfo(Model\FaxLineCreateRequest $fax_line_c } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -914,14 +949,14 @@ public function faxLineCreateWithHttpInfo(Model\FaxLineCreateRequest $fax_line_c sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -930,17 +965,18 @@ public function faxLineCreateWithHttpInfo(Model\FaxLineCreateRequest $fax_line_c if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FaxLineResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -957,19 +993,20 @@ public function faxLineCreateWithHttpInfo(Model\FaxLineCreateRequest $fax_line_c return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -986,9 +1023,11 @@ public function faxLineCreateWithHttpInfo(Model\FaxLineCreateRequest $fax_line_c return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1001,6 +1040,7 @@ public function faxLineCreateWithHttpInfo(Model\FaxLineCreateRequest $fax_line_c ); $e->setResponseObject($data); break; + } throw $e; } @@ -1011,14 +1051,14 @@ public function faxLineCreateWithHttpInfo(Model\FaxLineCreateRequest $fax_line_c * * Purchase Fax Line * - * @param Model\FaxLineCreateRequest $fax_line_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineCreateRequest $fax_line_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineCreate. This method will eventually become unavailable */ - public function faxLineCreateAsync(Model\FaxLineCreateRequest $fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) + public function faxLineCreateAsync($fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) { return $this->faxLineCreateAsyncWithHttpInfo($fax_line_create_request, $contentType) ->then( @@ -1033,14 +1073,14 @@ function ($response) { * * Purchase Fax Line * - * @param Model\FaxLineCreateRequest $fax_line_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineCreateRequest $fax_line_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineCreate. This method will eventually become unavailable */ - public function faxLineCreateAsyncWithHttpInfo(Model\FaxLineCreateRequest $fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) + public function faxLineCreateAsyncWithHttpInfo($fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; $request = $this->faxLineCreateRequest($fax_line_create_request, $contentType); @@ -1050,9 +1090,9 @@ public function faxLineCreateAsyncWithHttpInfo(Model\FaxLineCreateRequest $fax_l ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1061,7 +1101,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1075,7 +1115,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1084,22 +1124,24 @@ function ($exception) { /** * Create request for operation 'faxLineCreate' * - * @param Model\FaxLineCreateRequest $fax_line_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineCreateRequest $fax_line_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxLineCreate. This method will eventually become unavailable */ - public function faxLineCreateRequest(Model\FaxLineCreateRequest $fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) + public function faxLineCreateRequest($fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) { + // verify the required parameter 'fax_line_create_request' is set if ($fax_line_create_request === null || (is_array($fax_line_create_request) && count($fax_line_create_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $fax_line_create_request when calling faxLineCreate' ); } + $resourcePath = '/fax_line/create'; $formParams = []; $queryParams = []; @@ -1113,8 +1155,11 @@ public function faxLineCreateRequest(Model\FaxLineCreateRequest $fax_line_create $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1122,7 +1167,7 @@ public function faxLineCreateRequest(Model\FaxLineCreateRequest $fax_line_create // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_line_create_request)); } else { $httpBody = $fax_line_create_request; @@ -1135,7 +1180,7 @@ public function faxLineCreateRequest(Model\FaxLineCreateRequest $fax_line_create foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1152,8 +1197,9 @@ public function faxLineCreateRequest(Model\FaxLineCreateRequest $fax_line_create $payloadHook('multipart', $multipartContents, $fax_line_create_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1192,12 +1238,13 @@ public function faxLineCreateRequest(Model\FaxLineCreateRequest $fax_line_create * * Delete Fax Line * - * @param Model\FaxLineDeleteRequest $fax_line_delete_request fax_line_delete_request (required) + * @param \Dropbox\Sign\Model\FaxLineDeleteRequest $fax_line_delete_request fax_line_delete_request (required) * - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return void */ - public function faxLineDelete(Model\FaxLineDeleteRequest $fax_line_delete_request) + public function faxLineDelete($fax_line_delete_request) { $this->faxLineDeleteWithHttpInfo($fax_line_delete_request); } @@ -1207,15 +1254,15 @@ public function faxLineDelete(Model\FaxLineDeleteRequest $fax_line_delete_reques * * Delete Fax Line * - * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineDeleteRequest $fax_line_delete_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineDelete. This method will eventually become unavailable */ - public function faxLineDeleteWithHttpInfo(Model\FaxLineDeleteRequest $fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) + public function faxLineDeleteWithHttpInfo($fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) { $request = $this->faxLineDeleteRequest($fax_line_delete_request, $contentType); @@ -1227,14 +1274,14 @@ public function faxLineDeleteWithHttpInfo(Model\FaxLineDeleteRequest $fax_line_d } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1247,20 +1294,23 @@ public function faxLineDeleteWithHttpInfo(Model\FaxLineDeleteRequest $fax_line_d sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { + } throw $e; } @@ -1271,14 +1321,14 @@ public function faxLineDeleteWithHttpInfo(Model\FaxLineDeleteRequest $fax_line_d * * Delete Fax Line * - * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineDeleteRequest $fax_line_delete_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineDelete. This method will eventually become unavailable */ - public function faxLineDeleteAsync(Model\FaxLineDeleteRequest $fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) + public function faxLineDeleteAsync($fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) { return $this->faxLineDeleteAsyncWithHttpInfo($fax_line_delete_request, $contentType) ->then( @@ -1293,14 +1343,14 @@ function ($response) { * * Delete Fax Line * - * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineDeleteRequest $fax_line_delete_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineDelete. This method will eventually become unavailable */ - public function faxLineDeleteAsyncWithHttpInfo(Model\FaxLineDeleteRequest $fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) + public function faxLineDeleteAsyncWithHttpInfo($fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) { $returnType = ''; $request = $this->faxLineDeleteRequest($fax_line_delete_request, $contentType); @@ -1308,7 +1358,7 @@ public function faxLineDeleteAsyncWithHttpInfo(Model\FaxLineDeleteRequest $fax_l return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) { + function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -1322,7 +1372,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1331,22 +1381,24 @@ function ($exception) { /** * Create request for operation 'faxLineDelete' * - * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineDeleteRequest $fax_line_delete_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxLineDelete. This method will eventually become unavailable */ - public function faxLineDeleteRequest(Model\FaxLineDeleteRequest $fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) + public function faxLineDeleteRequest($fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) { + // verify the required parameter 'fax_line_delete_request' is set if ($fax_line_delete_request === null || (is_array($fax_line_delete_request) && count($fax_line_delete_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $fax_line_delete_request when calling faxLineDelete' ); } + $resourcePath = '/fax_line'; $formParams = []; $queryParams = []; @@ -1360,8 +1412,11 @@ public function faxLineDeleteRequest(Model\FaxLineDeleteRequest $fax_line_delete $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1369,7 +1424,7 @@ public function faxLineDeleteRequest(Model\FaxLineDeleteRequest $fax_line_delete // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_line_delete_request)); } else { $httpBody = $fax_line_delete_request; @@ -1382,7 +1437,7 @@ public function faxLineDeleteRequest(Model\FaxLineDeleteRequest $fax_line_delete foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1399,8 +1454,9 @@ public function faxLineDeleteRequest(Model\FaxLineDeleteRequest $fax_line_delete $payloadHook('multipart', $multipartContents, $fax_line_delete_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1439,13 +1495,13 @@ public function faxLineDeleteRequest(Model\FaxLineDeleteRequest $fax_line_delete * * Get Fax Line * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * - * @return Model\FaxLineResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function faxLineGet(string $number) + public function faxLineGet($number) { list($response) = $this->faxLineGetWithHttpInfo($number); return $response; @@ -1456,15 +1512,15 @@ public function faxLineGet(string $number) * * Get Fax Line * - * @param string $number The Fax Line number. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation + * @param string $number The Fax Line number (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * - * @return array of Model\FaxLineResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::faxLineGet. This method will eventually become unavailable */ - public function faxLineGetWithHttpInfo(string $number, string $contentType = self::contentTypes['faxLineGet'][0]) + public function faxLineGetWithHttpInfo($number, string $contentType = self::contentTypes['faxLineGet'][0]) { $request = $this->faxLineGetRequest($number, $contentType); @@ -1476,14 +1532,14 @@ public function faxLineGetWithHttpInfo(string $number, string $contentType = sel } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1496,14 +1552,14 @@ public function faxLineGetWithHttpInfo(string $number, string $contentType = sel sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1512,17 +1568,18 @@ public function faxLineGetWithHttpInfo(string $number, string $contentType = sel if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FaxLineResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1539,19 +1596,20 @@ public function faxLineGetWithHttpInfo(string $number, string $contentType = sel return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1568,9 +1626,11 @@ public function faxLineGetWithHttpInfo(string $number, string $contentType = sel return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1583,6 +1643,7 @@ public function faxLineGetWithHttpInfo(string $number, string $contentType = sel ); $e->setResponseObject($data); break; + } throw $e; } @@ -1593,14 +1654,14 @@ public function faxLineGetWithHttpInfo(string $number, string $contentType = sel * * Get Fax Line * - * @param string $number The Fax Line number. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation + * @param string $number The Fax Line number (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineGet. This method will eventually become unavailable */ - public function faxLineGetAsync(string $number, string $contentType = self::contentTypes['faxLineGet'][0]) + public function faxLineGetAsync($number, string $contentType = self::contentTypes['faxLineGet'][0]) { return $this->faxLineGetAsyncWithHttpInfo($number, $contentType) ->then( @@ -1615,14 +1676,14 @@ function ($response) { * * Get Fax Line * - * @param string $number The Fax Line number. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation + * @param string $number The Fax Line number (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineGet. This method will eventually become unavailable */ - public function faxLineGetAsyncWithHttpInfo(string $number, string $contentType = self::contentTypes['faxLineGet'][0]) + public function faxLineGetAsyncWithHttpInfo($number, string $contentType = self::contentTypes['faxLineGet'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; $request = $this->faxLineGetRequest($number, $contentType); @@ -1632,9 +1693,9 @@ public function faxLineGetAsyncWithHttpInfo(string $number, string $contentType ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1643,7 +1704,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1657,7 +1718,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1666,22 +1727,24 @@ function ($exception) { /** * Create request for operation 'faxLineGet' * - * @param string $number The Fax Line number. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation + * @param string $number The Fax Line number (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxLineGet. This method will eventually become unavailable */ - public function faxLineGetRequest(string $number, string $contentType = self::contentTypes['faxLineGet'][0]) + public function faxLineGetRequest($number, string $contentType = self::contentTypes['faxLineGet'][0]) { + // verify the required parameter 'number' is set if ($number === null || (is_array($number) && count($number) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $number when calling faxLineGet' ); } + $resourcePath = '/fax_line'; $formParams = []; $queryParams = []; @@ -1699,8 +1762,11 @@ public function faxLineGetRequest(string $number, string $contentType = self::co true // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1714,7 +1780,7 @@ public function faxLineGetRequest(string $number, string $contentType = self::co foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1728,8 +1794,9 @@ public function faxLineGetRequest(string $number, string $contentType = self::co } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1768,16 +1835,16 @@ public function faxLineGetRequest(string $number, string $contentType = self::co * * List Fax Lines * - * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param string $account_id Account ID (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * - * @return Model\FaxLineListResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FaxLineListResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function faxLineList(string $account_id = null, int $page = 1, int $page_size = 20, bool $show_team_lines = null) + public function faxLineList($account_id = null, $page = 1, $page_size = 20, $show_team_lines = null) { list($response) = $this->faxLineListWithHttpInfo($account_id, $page, $page_size, $show_team_lines); return $response; @@ -1788,18 +1855,18 @@ public function faxLineList(string $account_id = null, int $page = 1, int $page_ * * List Fax Lines * - * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation + * @param string $account_id Account ID (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * - * @return array of Model\FaxLineListResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FaxLineListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::faxLineList. This method will eventually become unavailable */ - public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, bool $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) + public function faxLineListWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) { $request = $this->faxLineListRequest($account_id, $page, $page_size, $show_team_lines, $contentType); @@ -1811,14 +1878,14 @@ public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1 } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1831,14 +1898,14 @@ public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1 sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1847,17 +1914,18 @@ public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1 if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineListResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FaxLineListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1874,19 +1942,20 @@ public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1 return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineListResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FaxLineListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1903,9 +1972,11 @@ public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1 return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1918,6 +1989,7 @@ public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1 ); $e->setResponseObject($data); break; + } throw $e; } @@ -1928,17 +2000,17 @@ public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1 * * List Fax Lines * - * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation + * @param string $account_id Account ID (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineList. This method will eventually become unavailable */ - public function faxLineListAsync(string $account_id = null, int $page = 1, int $page_size = 20, bool $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) + public function faxLineListAsync($account_id = null, $page = 1, $page_size = 20, $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) { return $this->faxLineListAsyncWithHttpInfo($account_id, $page, $page_size, $show_team_lines, $contentType) ->then( @@ -1953,17 +2025,17 @@ function ($response) { * * List Fax Lines * - * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation + * @param string $account_id Account ID (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineList. This method will eventually become unavailable */ - public function faxLineListAsyncWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, bool $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) + public function faxLineListAsyncWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineListResponse'; $request = $this->faxLineListRequest($account_id, $page, $page_size, $show_team_lines, $contentType); @@ -1973,9 +2045,9 @@ public function faxLineListAsyncWithHttpInfo(string $account_id = null, int $pag ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1984,7 +2056,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1998,7 +2070,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2007,18 +2079,24 @@ function ($exception) { /** * Create request for operation 'faxLineList' * - * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation + * @param string $account_id Account ID (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxLineList. This method will eventually become unavailable */ - public function faxLineListRequest(string $account_id = null, int $page = 1, int $page_size = 20, bool $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) + public function faxLineListRequest($account_id = null, $page = 1, $page_size = 20, $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) { + + + + + + $resourcePath = '/fax_line/list'; $formParams = []; $queryParams = []; @@ -2063,8 +2141,11 @@ public function faxLineListRequest(string $account_id = null, int $page = 1, int false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -2078,7 +2159,7 @@ public function faxLineListRequest(string $account_id = null, int $page = 1, int foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -2092,8 +2173,9 @@ public function faxLineListRequest(string $account_id = null, int $page = 1, int } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2132,13 +2214,13 @@ public function faxLineListRequest(string $account_id = null, int $page = 1, int * * Remove Fax Line Access * - * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request fax_line_remove_user_request (required) + * @param \Dropbox\Sign\Model\FaxLineRemoveUserRequest $fax_line_remove_user_request fax_line_remove_user_request (required) * - * @return Model\FaxLineResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function faxLineRemoveUser(Model\FaxLineRemoveUserRequest $fax_line_remove_user_request) + public function faxLineRemoveUser($fax_line_remove_user_request) { list($response) = $this->faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request); return $response; @@ -2149,15 +2231,15 @@ public function faxLineRemoveUser(Model\FaxLineRemoveUserRequest $fax_line_remov * * Remove Fax Line Access * - * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * - * @return array of Model\FaxLineResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::faxLineRemoveUser. This method will eventually become unavailable */ - public function faxLineRemoveUserWithHttpInfo(Model\FaxLineRemoveUserRequest $fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) + public function faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) { $request = $this->faxLineRemoveUserRequest($fax_line_remove_user_request, $contentType); @@ -2169,14 +2251,14 @@ public function faxLineRemoveUserWithHttpInfo(Model\FaxLineRemoveUserRequest $fa } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -2189,14 +2271,14 @@ public function faxLineRemoveUserWithHttpInfo(Model\FaxLineRemoveUserRequest $fa sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2205,17 +2287,18 @@ public function faxLineRemoveUserWithHttpInfo(Model\FaxLineRemoveUserRequest $fa if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FaxLineResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2232,19 +2315,20 @@ public function faxLineRemoveUserWithHttpInfo(Model\FaxLineRemoveUserRequest $fa return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2261,9 +2345,11 @@ public function faxLineRemoveUserWithHttpInfo(Model\FaxLineRemoveUserRequest $fa return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2276,6 +2362,7 @@ public function faxLineRemoveUserWithHttpInfo(Model\FaxLineRemoveUserRequest $fa ); $e->setResponseObject($data); break; + } throw $e; } @@ -2286,14 +2373,14 @@ public function faxLineRemoveUserWithHttpInfo(Model\FaxLineRemoveUserRequest $fa * * Remove Fax Line Access * - * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineRemoveUser. This method will eventually become unavailable */ - public function faxLineRemoveUserAsync(Model\FaxLineRemoveUserRequest $fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) + public function faxLineRemoveUserAsync($fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) { return $this->faxLineRemoveUserAsyncWithHttpInfo($fax_line_remove_user_request, $contentType) ->then( @@ -2308,14 +2395,14 @@ function ($response) { * * Remove Fax Line Access * - * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineRemoveUser. This method will eventually become unavailable */ - public function faxLineRemoveUserAsyncWithHttpInfo(Model\FaxLineRemoveUserRequest $fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) + public function faxLineRemoveUserAsyncWithHttpInfo($fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; $request = $this->faxLineRemoveUserRequest($fax_line_remove_user_request, $contentType); @@ -2325,9 +2412,9 @@ public function faxLineRemoveUserAsyncWithHttpInfo(Model\FaxLineRemoveUserReques ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2336,7 +2423,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -2350,7 +2437,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2359,22 +2446,24 @@ function ($exception) { /** * Create request for operation 'faxLineRemoveUser' * - * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::faxLineRemoveUser. This method will eventually become unavailable */ - public function faxLineRemoveUserRequest(Model\FaxLineRemoveUserRequest $fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) + public function faxLineRemoveUserRequest($fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) { + // verify the required parameter 'fax_line_remove_user_request' is set if ($fax_line_remove_user_request === null || (is_array($fax_line_remove_user_request) && count($fax_line_remove_user_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $fax_line_remove_user_request when calling faxLineRemoveUser' ); } + $resourcePath = '/fax_line/remove_user'; $formParams = []; $queryParams = []; @@ -2388,8 +2477,11 @@ public function faxLineRemoveUserRequest(Model\FaxLineRemoveUserRequest $fax_lin $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -2397,7 +2489,7 @@ public function faxLineRemoveUserRequest(Model\FaxLineRemoveUserRequest $fax_lin // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_line_remove_user_request)); } else { $httpBody = $fax_line_remove_user_request; @@ -2410,7 +2502,7 @@ public function faxLineRemoveUserRequest(Model\FaxLineRemoveUserRequest $fax_lin foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -2427,8 +2519,9 @@ public function faxLineRemoveUserRequest(Model\FaxLineRemoveUserRequest $fax_lin $payloadHook('multipart', $multipartContents, $fax_line_remove_user_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2465,8 +2558,8 @@ public function faxLineRemoveUserRequest(Model\FaxLineRemoveUserRequest $fax_lin /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -2474,7 +2567,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -2490,8 +2583,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -2501,9 +2594,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -2522,8 +2615,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/OAuthApi.php b/sdks/php/src/Api/OAuthApi.php index 81468626d..52e7bd4fa 100644 --- a/sdks/php/src/Api/OAuthApi.php +++ b/sdks/php/src/Api/OAuthApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,34 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; /** * OAuthApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class OAuthApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'oauthTokenGenerate' => [ 'application/json', @@ -79,13 +86,16 @@ class OAuthApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -99,7 +109,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -140,13 +150,13 @@ public function getResponse() * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param Model\OAuthTokenGenerateRequest $o_auth_token_generate_request o_auth_token_generate_request (required) + * @param \Dropbox\Sign\Model\OAuthTokenGenerateRequest $o_auth_token_generate_request o_auth_token_generate_request (required) * - * @return Model\OAuthTokenResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\OAuthTokenResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function oauthTokenGenerate(Model\OAuthTokenGenerateRequest $o_auth_token_generate_request) + public function oauthTokenGenerate($o_auth_token_generate_request) { list($response) = $this->oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request); return $response; @@ -161,17 +171,17 @@ public function oauthTokenGenerate(Model\OAuthTokenGenerateRequest $o_auth_token * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) - * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) + * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation * - * @return array of Model\OAuthTokenResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\OAuthTokenResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::oauthTokenGenerate. This method will eventually become unavailable */ - public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) + public function oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) { $request = $this->oauthTokenGenerateRequest($o_auth_token_generate_request, $hostIndex, $variables, $contentType); @@ -183,14 +193,14 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -203,14 +213,14 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -219,17 +229,18 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\OAuthTokenResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\OAuthTokenResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -246,19 +257,20 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\OAuthTokenResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\OAuthTokenResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -275,9 +287,11 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -290,6 +304,7 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ ); $e->setResponseObject($data); break; + } throw $e; } @@ -304,16 +319,16 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) - * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) + * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenGenerate. This method will eventually become unavailable */ - public function oauthTokenGenerateAsync(Model\OAuthTokenGenerateRequest $o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) + public function oauthTokenGenerateAsync($o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) { return $this->oauthTokenGenerateAsyncWithHttpInfo($o_auth_token_generate_request, $hostIndex, $variables, $contentType) ->then( @@ -332,16 +347,16 @@ function ($response) { * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) - * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) + * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenGenerate. This method will eventually become unavailable */ - public function oauthTokenGenerateAsyncWithHttpInfo(Model\OAuthTokenGenerateRequest $o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) + public function oauthTokenGenerateAsyncWithHttpInfo($o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) { $returnType = '\Dropbox\Sign\Model\OAuthTokenResponse'; $request = $this->oauthTokenGenerateRequest($o_auth_token_generate_request, $hostIndex, $variables, $contentType); @@ -351,9 +366,9 @@ public function oauthTokenGenerateAsyncWithHttpInfo(Model\OAuthTokenGenerateRequ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -362,7 +377,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -376,7 +391,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -385,28 +400,30 @@ function ($exception) { /** * Create request for operation 'oauthTokenGenerate' * - * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. - * if needed, use the 'variables' parameter to pass variables to the host. + * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. + * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) - * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) + * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::oauthTokenGenerate. This method will eventually become unavailable */ - public function oauthTokenGenerateRequest(Model\OAuthTokenGenerateRequest $o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) + public function oauthTokenGenerateRequest($o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) { + // verify the required parameter 'o_auth_token_generate_request' is set if ($o_auth_token_generate_request === null || (is_array($o_auth_token_generate_request) && count($o_auth_token_generate_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $o_auth_token_generate_request when calling oauthTokenGenerate' ); } + $resourcePath = '/oauth/token'; $formParams = []; $queryParams = []; @@ -420,8 +437,11 @@ public function oauthTokenGenerateRequest(Model\OAuthTokenGenerateRequest $o_aut $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -429,7 +449,7 @@ public function oauthTokenGenerateRequest(Model\OAuthTokenGenerateRequest $o_aut // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($o_auth_token_generate_request)); } else { $httpBody = $o_auth_token_generate_request; @@ -442,7 +462,7 @@ public function oauthTokenGenerateRequest(Model\OAuthTokenGenerateRequest $o_aut foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -459,8 +479,9 @@ public function oauthTokenGenerateRequest(Model\OAuthTokenGenerateRequest $o_aut $payloadHook('multipart', $multipartContents, $o_auth_token_generate_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -468,6 +489,7 @@ public function oauthTokenGenerateRequest(Model\OAuthTokenGenerateRequest $o_aut } } + $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); @@ -479,7 +501,7 @@ public function oauthTokenGenerateRequest(Model\OAuthTokenGenerateRequest $o_aut $headers ); - // Preserve the original behavior of server indexing. + # Preserve the original behavior of server indexing. if ($hostIndex === null) { $hostIndex = $this->hostIndex; } @@ -487,7 +509,7 @@ public function oauthTokenGenerateRequest(Model\OAuthTokenGenerateRequest $o_aut $hostSettings = $this->getHostSettingsForoauthTokenGenerate(); if ($hostIndex < 0 || $hostIndex >= count($hostSettings)) { - throw new InvalidArgumentException("Invalid index {$hostIndex} when selecting the host. Must be less than " . count($hostSettings)); + throw new \InvalidArgumentException("Invalid index {$hostIndex} when selecting the host. Must be less than ".count($hostSettings)); } $operationHost = Configuration::getHostString($hostSettings, $hostIndex, $variables); $query = ObjectSerializer::buildQuery($queryParams); @@ -508,9 +530,9 @@ protected function getHostSettingsForoauthTokenGenerate(): array { return [ [ - 'url' => 'https://app.hellosign.com', - 'description' => 'No description provided', - ], + "url" => "https://app.hellosign.com", + "description" => "No description provided", + ] ]; } @@ -523,13 +545,13 @@ protected function getHostSettingsForoauthTokenGenerate(): array * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request o_auth_token_refresh_request (required) + * @param \Dropbox\Sign\Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request o_auth_token_refresh_request (required) * - * @return Model\OAuthTokenResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\OAuthTokenResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function oauthTokenRefresh(Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request) + public function oauthTokenRefresh($o_auth_token_refresh_request) { list($response) = $this->oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request); return $response; @@ -544,17 +566,17 @@ public function oauthTokenRefresh(Model\OAuthTokenRefreshRequest $o_auth_token_r * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) - * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) + * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation * - * @return array of Model\OAuthTokenResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\OAuthTokenResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::oauthTokenRefresh. This method will eventually become unavailable */ - public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) + public function oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) { $request = $this->oauthTokenRefreshRequest($o_auth_token_refresh_request, $hostIndex, $variables, $contentType); @@ -566,14 +588,14 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -586,14 +608,14 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -602,17 +624,18 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\OAuthTokenResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\OAuthTokenResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -629,19 +652,20 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\OAuthTokenResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\OAuthTokenResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -658,9 +682,11 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -673,6 +699,7 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ ); $e->setResponseObject($data); break; + } throw $e; } @@ -687,16 +714,16 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) - * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) + * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenRefresh. This method will eventually become unavailable */ - public function oauthTokenRefreshAsync(Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) + public function oauthTokenRefreshAsync($o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) { return $this->oauthTokenRefreshAsyncWithHttpInfo($o_auth_token_refresh_request, $hostIndex, $variables, $contentType) ->then( @@ -715,16 +742,16 @@ function ($response) { * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) - * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) + * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenRefresh. This method will eventually become unavailable */ - public function oauthTokenRefreshAsyncWithHttpInfo(Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) + public function oauthTokenRefreshAsyncWithHttpInfo($o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) { $returnType = '\Dropbox\Sign\Model\OAuthTokenResponse'; $request = $this->oauthTokenRefreshRequest($o_auth_token_refresh_request, $hostIndex, $variables, $contentType); @@ -734,9 +761,9 @@ public function oauthTokenRefreshAsyncWithHttpInfo(Model\OAuthTokenRefreshReques ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -745,7 +772,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -759,7 +786,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -768,28 +795,30 @@ function ($exception) { /** * Create request for operation 'oauthTokenRefresh' * - * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. - * if needed, use the 'variables' parameter to pass variables to the host. + * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. + * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) - * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) + * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::oauthTokenRefresh. This method will eventually become unavailable */ - public function oauthTokenRefreshRequest(Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) + public function oauthTokenRefreshRequest($o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) { + // verify the required parameter 'o_auth_token_refresh_request' is set if ($o_auth_token_refresh_request === null || (is_array($o_auth_token_refresh_request) && count($o_auth_token_refresh_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $o_auth_token_refresh_request when calling oauthTokenRefresh' ); } + $resourcePath = '/oauth/token?refresh'; $formParams = []; $queryParams = []; @@ -803,8 +832,11 @@ public function oauthTokenRefreshRequest(Model\OAuthTokenRefreshRequest $o_auth_ $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -812,7 +844,7 @@ public function oauthTokenRefreshRequest(Model\OAuthTokenRefreshRequest $o_auth_ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($o_auth_token_refresh_request)); } else { $httpBody = $o_auth_token_refresh_request; @@ -825,7 +857,7 @@ public function oauthTokenRefreshRequest(Model\OAuthTokenRefreshRequest $o_auth_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -842,8 +874,9 @@ public function oauthTokenRefreshRequest(Model\OAuthTokenRefreshRequest $o_auth_ $payloadHook('multipart', $multipartContents, $o_auth_token_refresh_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -851,6 +884,7 @@ public function oauthTokenRefreshRequest(Model\OAuthTokenRefreshRequest $o_auth_ } } + $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); @@ -862,7 +896,7 @@ public function oauthTokenRefreshRequest(Model\OAuthTokenRefreshRequest $o_auth_ $headers ); - // Preserve the original behavior of server indexing. + # Preserve the original behavior of server indexing. if ($hostIndex === null) { $hostIndex = $this->hostIndex; } @@ -870,7 +904,7 @@ public function oauthTokenRefreshRequest(Model\OAuthTokenRefreshRequest $o_auth_ $hostSettings = $this->getHostSettingsForoauthTokenRefresh(); if ($hostIndex < 0 || $hostIndex >= count($hostSettings)) { - throw new InvalidArgumentException("Invalid index {$hostIndex} when selecting the host. Must be less than " . count($hostSettings)); + throw new \InvalidArgumentException("Invalid index {$hostIndex} when selecting the host. Must be less than ".count($hostSettings)); } $operationHost = Configuration::getHostString($hostSettings, $hostIndex, $variables); $query = ObjectSerializer::buildQuery($queryParams); @@ -891,17 +925,17 @@ protected function getHostSettingsForoauthTokenRefresh(): array { return [ [ - 'url' => 'https://app.hellosign.com', - 'description' => 'No description provided', - ], + "url" => "https://app.hellosign.com", + "description" => "No description provided", + ] ]; } /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -909,7 +943,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -925,8 +959,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -936,9 +970,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -957,8 +991,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/ReportApi.php b/sdks/php/src/Api/ReportApi.php index 987fc25fe..902907e37 100644 --- a/sdks/php/src/Api/ReportApi.php +++ b/sdks/php/src/Api/ReportApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,34 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; /** * ReportApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class ReportApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'reportCreate' => [ 'application/json', @@ -76,13 +83,16 @@ class ReportApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -96,7 +106,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -133,13 +143,13 @@ public function getResponse() * * Create Report * - * @param Model\ReportCreateRequest $report_create_request report_create_request (required) + * @param \Dropbox\Sign\Model\ReportCreateRequest $report_create_request report_create_request (required) * - * @return Model\ReportCreateResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\ReportCreateResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function reportCreate(Model\ReportCreateRequest $report_create_request) + public function reportCreate($report_create_request) { list($response) = $this->reportCreateWithHttpInfo($report_create_request); return $response; @@ -150,15 +160,15 @@ public function reportCreate(Model\ReportCreateRequest $report_create_request) * * Create Report * - * @param Model\ReportCreateRequest $report_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\ReportCreateRequest $report_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * - * @return array of Model\ReportCreateResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\ReportCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::reportCreate. This method will eventually become unavailable */ - public function reportCreateWithHttpInfo(Model\ReportCreateRequest $report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) + public function reportCreateWithHttpInfo($report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) { $request = $this->reportCreateRequest($report_create_request, $contentType); @@ -170,14 +180,14 @@ public function reportCreateWithHttpInfo(Model\ReportCreateRequest $report_creat } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -190,14 +200,14 @@ public function reportCreateWithHttpInfo(Model\ReportCreateRequest $report_creat sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -206,17 +216,18 @@ public function reportCreateWithHttpInfo(Model\ReportCreateRequest $report_creat if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\ReportCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\ReportCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -233,19 +244,20 @@ public function reportCreateWithHttpInfo(Model\ReportCreateRequest $report_creat return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\ReportCreateResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\ReportCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -262,9 +274,11 @@ public function reportCreateWithHttpInfo(Model\ReportCreateRequest $report_creat return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -277,6 +291,7 @@ public function reportCreateWithHttpInfo(Model\ReportCreateRequest $report_creat ); $e->setResponseObject($data); break; + } throw $e; } @@ -287,14 +302,14 @@ public function reportCreateWithHttpInfo(Model\ReportCreateRequest $report_creat * * Create Report * - * @param Model\ReportCreateRequest $report_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\ReportCreateRequest $report_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::reportCreate. This method will eventually become unavailable */ - public function reportCreateAsync(Model\ReportCreateRequest $report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) + public function reportCreateAsync($report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) { return $this->reportCreateAsyncWithHttpInfo($report_create_request, $contentType) ->then( @@ -309,14 +324,14 @@ function ($response) { * * Create Report * - * @param Model\ReportCreateRequest $report_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\ReportCreateRequest $report_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::reportCreate. This method will eventually become unavailable */ - public function reportCreateAsyncWithHttpInfo(Model\ReportCreateRequest $report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) + public function reportCreateAsyncWithHttpInfo($report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) { $returnType = '\Dropbox\Sign\Model\ReportCreateResponse'; $request = $this->reportCreateRequest($report_create_request, $contentType); @@ -326,9 +341,9 @@ public function reportCreateAsyncWithHttpInfo(Model\ReportCreateRequest $report_ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -337,7 +352,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -351,7 +366,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -360,22 +375,24 @@ function ($exception) { /** * Create request for operation 'reportCreate' * - * @param Model\ReportCreateRequest $report_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\ReportCreateRequest $report_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::reportCreate. This method will eventually become unavailable */ - public function reportCreateRequest(Model\ReportCreateRequest $report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) + public function reportCreateRequest($report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) { + // verify the required parameter 'report_create_request' is set if ($report_create_request === null || (is_array($report_create_request) && count($report_create_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $report_create_request when calling reportCreate' ); } + $resourcePath = '/report/create'; $formParams = []; $queryParams = []; @@ -389,8 +406,11 @@ public function reportCreateRequest(Model\ReportCreateRequest $report_create_req $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -398,7 +418,7 @@ public function reportCreateRequest(Model\ReportCreateRequest $report_create_req // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($report_create_request)); } else { $httpBody = $report_create_request; @@ -411,7 +431,7 @@ public function reportCreateRequest(Model\ReportCreateRequest $report_create_req foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -428,8 +448,9 @@ public function reportCreateRequest(Model\ReportCreateRequest $report_create_req $payloadHook('multipart', $multipartContents, $report_create_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -466,8 +487,8 @@ public function reportCreateRequest(Model\ReportCreateRequest $report_create_req /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -475,7 +496,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -491,8 +512,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -502,9 +523,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -523,8 +544,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/SignatureRequestApi.php b/sdks/php/src/Api/SignatureRequestApi.php index e8da69d75..dc69531dd 100644 --- a/sdks/php/src/Api/SignatureRequestApi.php +++ b/sdks/php/src/Api/SignatureRequestApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,35 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; -use SplFileObject; /** * SignatureRequestApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class SignatureRequestApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'signatureRequestBulkCreateEmbeddedWithTemplate' => [ 'application/json', @@ -128,13 +134,16 @@ class SignatureRequestApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -148,7 +157,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -185,13 +194,13 @@ public function getResponse() * * Embedded Bulk Send with Template * - * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request signature_request_bulk_create_embedded_with_template_request (required) + * @param \Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request signature_request_bulk_create_embedded_with_template_request (required) * - * @return Model\BulkSendJobSendResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\BulkSendJobSendResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestBulkCreateEmbeddedWithTemplate(Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request) + public function signatureRequestBulkCreateEmbeddedWithTemplate($signature_request_bulk_create_embedded_with_template_request) { list($response) = $this->signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($signature_request_bulk_create_embedded_with_template_request); return $response; @@ -202,15 +211,15 @@ public function signatureRequestBulkCreateEmbeddedWithTemplate(Model\SignatureRe * * Embedded Bulk Send with Template * - * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @return array of Model\BulkSendJobSendResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\BulkSendJobSendResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestBulkCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) + public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) { $request = $this->signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature_request_bulk_create_embedded_with_template_request, $contentType); @@ -222,14 +231,14 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(Model } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -242,14 +251,14 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(Model sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -258,17 +267,18 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(Model if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\BulkSendJobSendResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\BulkSendJobSendResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -285,19 +295,20 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(Model return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\BulkSendJobSendResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\BulkSendJobSendResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -314,9 +325,11 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(Model return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -329,6 +342,7 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(Model ); $e->setResponseObject($data); break; + } throw $e; } @@ -339,14 +353,14 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(Model * * Embedded Bulk Send with Template * - * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkCreateEmbeddedWithTemplateAsync(Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) + public function signatureRequestBulkCreateEmbeddedWithTemplateAsync($signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) { return $this->signatureRequestBulkCreateEmbeddedWithTemplateAsyncWithHttpInfo($signature_request_bulk_create_embedded_with_template_request, $contentType) ->then( @@ -361,14 +375,14 @@ function ($response) { * * Embedded Bulk Send with Template * - * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkCreateEmbeddedWithTemplateAsyncWithHttpInfo(Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) + public function signatureRequestBulkCreateEmbeddedWithTemplateAsyncWithHttpInfo($signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) { $returnType = '\Dropbox\Sign\Model\BulkSendJobSendResponse'; $request = $this->signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature_request_bulk_create_embedded_with_template_request, $contentType); @@ -378,9 +392,9 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateAsyncWithHttpInfo( ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -389,7 +403,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -403,7 +417,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -412,22 +426,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestBulkCreateEmbeddedWithTemplate' * - * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestBulkCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkCreateEmbeddedWithTemplateRequest(Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) + public function signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) { + // verify the required parameter 'signature_request_bulk_create_embedded_with_template_request' is set if ($signature_request_bulk_create_embedded_with_template_request === null || (is_array($signature_request_bulk_create_embedded_with_template_request) && count($signature_request_bulk_create_embedded_with_template_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_bulk_create_embedded_with_template_request when calling signatureRequestBulkCreateEmbeddedWithTemplate' ); } + $resourcePath = '/signature_request/bulk_create_embedded_with_template'; $formParams = []; $queryParams = []; @@ -441,8 +457,11 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest(Model\Sign $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -450,7 +469,7 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest(Model\Sign // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_bulk_create_embedded_with_template_request)); } else { $httpBody = $signature_request_bulk_create_embedded_with_template_request; @@ -463,7 +482,7 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest(Model\Sign foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -480,8 +499,9 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest(Model\Sign $payloadHook('multipart', $multipartContents, $signature_request_bulk_create_embedded_with_template_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -520,13 +540,13 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest(Model\Sign * * Bulk Send with Template * - * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request signature_request_bulk_send_with_template_request (required) + * @param \Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request signature_request_bulk_send_with_template_request (required) * - * @return Model\BulkSendJobSendResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\BulkSendJobSendResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestBulkSendWithTemplate(Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request) + public function signatureRequestBulkSendWithTemplate($signature_request_bulk_send_with_template_request) { list($response) = $this->signatureRequestBulkSendWithTemplateWithHttpInfo($signature_request_bulk_send_with_template_request); return $response; @@ -537,15 +557,15 @@ public function signatureRequestBulkSendWithTemplate(Model\SignatureRequestBulkS * * Bulk Send with Template * - * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * - * @return array of Model\BulkSendJobSendResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\BulkSendJobSendResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestBulkSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkSendWithTemplateWithHttpInfo(Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) + public function signatureRequestBulkSendWithTemplateWithHttpInfo($signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) { $request = $this->signatureRequestBulkSendWithTemplateRequest($signature_request_bulk_send_with_template_request, $contentType); @@ -557,14 +577,14 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo(Model\Signature } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -577,14 +597,14 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo(Model\Signature sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -593,17 +613,18 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo(Model\Signature if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\BulkSendJobSendResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\BulkSendJobSendResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -620,19 +641,20 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo(Model\Signature return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\BulkSendJobSendResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\BulkSendJobSendResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -649,9 +671,11 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo(Model\Signature return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -664,6 +688,7 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo(Model\Signature ); $e->setResponseObject($data); break; + } throw $e; } @@ -674,14 +699,14 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo(Model\Signature * * Bulk Send with Template * - * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkSendWithTemplateAsync(Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) + public function signatureRequestBulkSendWithTemplateAsync($signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) { return $this->signatureRequestBulkSendWithTemplateAsyncWithHttpInfo($signature_request_bulk_send_with_template_request, $contentType) ->then( @@ -696,14 +721,14 @@ function ($response) { * * Bulk Send with Template * - * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkSendWithTemplateAsyncWithHttpInfo(Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) + public function signatureRequestBulkSendWithTemplateAsyncWithHttpInfo($signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) { $returnType = '\Dropbox\Sign\Model\BulkSendJobSendResponse'; $request = $this->signatureRequestBulkSendWithTemplateRequest($signature_request_bulk_send_with_template_request, $contentType); @@ -713,9 +738,9 @@ public function signatureRequestBulkSendWithTemplateAsyncWithHttpInfo(Model\Sign ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -724,7 +749,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -738,7 +763,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -747,22 +772,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestBulkSendWithTemplate' * - * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestBulkSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkSendWithTemplateRequest(Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) + public function signatureRequestBulkSendWithTemplateRequest($signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) { + // verify the required parameter 'signature_request_bulk_send_with_template_request' is set if ($signature_request_bulk_send_with_template_request === null || (is_array($signature_request_bulk_send_with_template_request) && count($signature_request_bulk_send_with_template_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_bulk_send_with_template_request when calling signatureRequestBulkSendWithTemplate' ); } + $resourcePath = '/signature_request/bulk_send_with_template'; $formParams = []; $queryParams = []; @@ -776,8 +803,11 @@ public function signatureRequestBulkSendWithTemplateRequest(Model\SignatureReque $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -785,7 +815,7 @@ public function signatureRequestBulkSendWithTemplateRequest(Model\SignatureReque // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_bulk_send_with_template_request)); } else { $httpBody = $signature_request_bulk_send_with_template_request; @@ -798,7 +828,7 @@ public function signatureRequestBulkSendWithTemplateRequest(Model\SignatureReque foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -815,8 +845,9 @@ public function signatureRequestBulkSendWithTemplateRequest(Model\SignatureReque $payloadHook('multipart', $multipartContents, $signature_request_bulk_send_with_template_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -859,12 +890,13 @@ public function signatureRequestBulkSendWithTemplateRequest(Model\SignatureReque * * Cancel Incomplete Signature Request * - * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) + * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) * - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return void */ - public function signatureRequestCancel(string $signature_request_id) + public function signatureRequestCancel($signature_request_id) { $this->signatureRequestCancelWithHttpInfo($signature_request_id); } @@ -874,15 +906,15 @@ public function signatureRequestCancel(string $signature_request_id) * * Cancel Incomplete Signature Request * - * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation + * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCancel. This method will eventually become unavailable */ - public function signatureRequestCancelWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) + public function signatureRequestCancelWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) { $request = $this->signatureRequestCancelRequest($signature_request_id, $contentType); @@ -894,14 +926,14 @@ public function signatureRequestCancelWithHttpInfo(string $signature_request_id, } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -914,20 +946,23 @@ public function signatureRequestCancelWithHttpInfo(string $signature_request_id, sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { + } throw $e; } @@ -938,14 +973,14 @@ public function signatureRequestCancelWithHttpInfo(string $signature_request_id, * * Cancel Incomplete Signature Request * - * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation + * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCancel. This method will eventually become unavailable */ - public function signatureRequestCancelAsync(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) + public function signatureRequestCancelAsync($signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) { return $this->signatureRequestCancelAsyncWithHttpInfo($signature_request_id, $contentType) ->then( @@ -960,14 +995,14 @@ function ($response) { * * Cancel Incomplete Signature Request * - * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation + * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCancel. This method will eventually become unavailable */ - public function signatureRequestCancelAsyncWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) + public function signatureRequestCancelAsyncWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) { $returnType = ''; $request = $this->signatureRequestCancelRequest($signature_request_id, $contentType); @@ -975,7 +1010,7 @@ public function signatureRequestCancelAsyncWithHttpInfo(string $signature_reques return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) { + function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -989,7 +1024,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -998,22 +1033,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestCancel' * - * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation + * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestCancel. This method will eventually become unavailable */ - public function signatureRequestCancelRequest(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) + public function signatureRequestCancelRequest($signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) { + // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestCancel' ); } + $resourcePath = '/signature_request/cancel/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -1021,17 +1058,20 @@ public function signatureRequestCancelRequest(string $signature_request_id, stri $httpBody = ''; $multipart = false; + + // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{signature_request_id}', + '{' . 'signature_request_id' . '}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1045,7 +1085,7 @@ public function signatureRequestCancelRequest(string $signature_request_id, stri foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1059,8 +1099,9 @@ public function signatureRequestCancelRequest(string $signature_request_id, stri } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1103,13 +1144,13 @@ public function signatureRequestCancelRequest(string $signature_request_id, stri * * Create Embedded Signature Request * - * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request signature_request_create_embedded_request (required) + * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request signature_request_create_embedded_request (required) * - * @return Model\SignatureRequestGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestCreateEmbedded(Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request) + public function signatureRequestCreateEmbedded($signature_request_create_embedded_request) { list($response) = $this->signatureRequestCreateEmbeddedWithHttpInfo($signature_request_create_embedded_request); return $response; @@ -1120,15 +1161,15 @@ public function signatureRequestCreateEmbedded(Model\SignatureRequestCreateEmbed * * Create Embedded Signature Request * - * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * - * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestCreateEmbedded. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedWithHttpInfo(Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) + public function signatureRequestCreateEmbeddedWithHttpInfo($signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) { $request = $this->signatureRequestCreateEmbeddedRequest($signature_request_create_embedded_request, $contentType); @@ -1140,14 +1181,14 @@ public function signatureRequestCreateEmbeddedWithHttpInfo(Model\SignatureReques } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1160,14 +1201,14 @@ public function signatureRequestCreateEmbeddedWithHttpInfo(Model\SignatureReques sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1176,17 +1217,18 @@ public function signatureRequestCreateEmbeddedWithHttpInfo(Model\SignatureReques if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1203,19 +1245,20 @@ public function signatureRequestCreateEmbeddedWithHttpInfo(Model\SignatureReques return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1232,9 +1275,11 @@ public function signatureRequestCreateEmbeddedWithHttpInfo(Model\SignatureReques return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1247,6 +1292,7 @@ public function signatureRequestCreateEmbeddedWithHttpInfo(Model\SignatureReques ); $e->setResponseObject($data); break; + } throw $e; } @@ -1257,14 +1303,14 @@ public function signatureRequestCreateEmbeddedWithHttpInfo(Model\SignatureReques * * Create Embedded Signature Request * - * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbedded. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedAsync(Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) + public function signatureRequestCreateEmbeddedAsync($signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) { return $this->signatureRequestCreateEmbeddedAsyncWithHttpInfo($signature_request_create_embedded_request, $contentType) ->then( @@ -1279,14 +1325,14 @@ function ($response) { * * Create Embedded Signature Request * - * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbedded. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedAsyncWithHttpInfo(Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) + public function signatureRequestCreateEmbeddedAsyncWithHttpInfo($signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestCreateEmbeddedRequest($signature_request_create_embedded_request, $contentType); @@ -1296,9 +1342,9 @@ public function signatureRequestCreateEmbeddedAsyncWithHttpInfo(Model\SignatureR ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1307,7 +1353,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1321,7 +1367,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1330,22 +1376,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestCreateEmbedded' * - * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestCreateEmbedded. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedRequest(Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) + public function signatureRequestCreateEmbeddedRequest($signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) { + // verify the required parameter 'signature_request_create_embedded_request' is set if ($signature_request_create_embedded_request === null || (is_array($signature_request_create_embedded_request) && count($signature_request_create_embedded_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_create_embedded_request when calling signatureRequestCreateEmbedded' ); } + $resourcePath = '/signature_request/create_embedded'; $formParams = []; $queryParams = []; @@ -1359,8 +1407,11 @@ public function signatureRequestCreateEmbeddedRequest(Model\SignatureRequestCrea $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1368,7 +1419,7 @@ public function signatureRequestCreateEmbeddedRequest(Model\SignatureRequestCrea // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_create_embedded_request)); } else { $httpBody = $signature_request_create_embedded_request; @@ -1381,7 +1432,7 @@ public function signatureRequestCreateEmbeddedRequest(Model\SignatureRequestCrea foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1398,8 +1449,9 @@ public function signatureRequestCreateEmbeddedRequest(Model\SignatureRequestCrea $payloadHook('multipart', $multipartContents, $signature_request_create_embedded_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1442,13 +1494,13 @@ public function signatureRequestCreateEmbeddedRequest(Model\SignatureRequestCrea * * Create Embedded Signature Request with Template * - * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request signature_request_create_embedded_with_template_request (required) + * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request signature_request_create_embedded_with_template_request (required) * - * @return Model\SignatureRequestGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestCreateEmbeddedWithTemplate(Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request) + public function signatureRequestCreateEmbeddedWithTemplate($signature_request_create_embedded_with_template_request) { list($response) = $this->signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signature_request_create_embedded_with_template_request); return $response; @@ -1459,15 +1511,15 @@ public function signatureRequestCreateEmbeddedWithTemplate(Model\SignatureReques * * Create Embedded Signature Request with Template * - * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) + public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) { $request = $this->signatureRequestCreateEmbeddedWithTemplateRequest($signature_request_create_embedded_with_template_request, $contentType); @@ -1479,14 +1531,14 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(Model\Sig } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1499,14 +1551,14 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(Model\Sig sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1515,17 +1567,18 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(Model\Sig if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1542,19 +1595,20 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(Model\Sig return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1571,9 +1625,11 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(Model\Sig return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1586,6 +1642,7 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(Model\Sig ); $e->setResponseObject($data); break; + } throw $e; } @@ -1596,14 +1653,14 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(Model\Sig * * Create Embedded Signature Request with Template * - * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedWithTemplateAsync(Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) + public function signatureRequestCreateEmbeddedWithTemplateAsync($signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) { return $this->signatureRequestCreateEmbeddedWithTemplateAsyncWithHttpInfo($signature_request_create_embedded_with_template_request, $contentType) ->then( @@ -1618,14 +1675,14 @@ function ($response) { * * Create Embedded Signature Request with Template * - * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedWithTemplateAsyncWithHttpInfo(Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) + public function signatureRequestCreateEmbeddedWithTemplateAsyncWithHttpInfo($signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestCreateEmbeddedWithTemplateRequest($signature_request_create_embedded_with_template_request, $contentType); @@ -1635,9 +1692,9 @@ public function signatureRequestCreateEmbeddedWithTemplateAsyncWithHttpInfo(Mode ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1646,7 +1703,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1660,7 +1717,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1669,22 +1726,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestCreateEmbeddedWithTemplate' * - * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedWithTemplateRequest(Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) + public function signatureRequestCreateEmbeddedWithTemplateRequest($signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) { + // verify the required parameter 'signature_request_create_embedded_with_template_request' is set if ($signature_request_create_embedded_with_template_request === null || (is_array($signature_request_create_embedded_with_template_request) && count($signature_request_create_embedded_with_template_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_create_embedded_with_template_request when calling signatureRequestCreateEmbeddedWithTemplate' ); } + $resourcePath = '/signature_request/create_embedded_with_template'; $formParams = []; $queryParams = []; @@ -1698,8 +1757,11 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest(Model\Signatur $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1707,7 +1769,7 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest(Model\Signatur // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_create_embedded_with_template_request)); } else { $httpBody = $signature_request_create_embedded_with_template_request; @@ -1720,7 +1782,7 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest(Model\Signatur foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1737,8 +1799,9 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest(Model\Signatur $payloadHook('multipart', $multipartContents, $signature_request_create_embedded_with_template_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1781,14 +1844,14 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest(Model\Signatur * * Download Files * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') * - * @return SplFileObject - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \SplFileObject|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestFiles(string $signature_request_id, string $file_type = 'pdf') + public function signatureRequestFiles($signature_request_id, $file_type = 'pdf') { list($response) = $this->signatureRequestFilesWithHttpInfo($signature_request_id, $file_type); return $response; @@ -1799,16 +1862,16 @@ public function signatureRequestFiles(string $signature_request_id, string $file * * Download Files * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException * @return array of \SplFileObject|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFiles. This method will eventually become unavailable */ - public function signatureRequestFilesWithHttpInfo(string $signature_request_id, string $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) + public function signatureRequestFilesWithHttpInfo($signature_request_id, $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) { $request = $this->signatureRequestFilesRequest($signature_request_id, $file_type, $contentType); @@ -1820,14 +1883,14 @@ public function signatureRequestFilesWithHttpInfo(string $signature_request_id, } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1840,14 +1903,14 @@ public function signatureRequestFilesWithHttpInfo(string $signature_request_id, sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1856,17 +1919,18 @@ public function signatureRequestFilesWithHttpInfo(string $signature_request_id, if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\SplFileObject' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\SplFileObject' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1883,19 +1947,20 @@ public function signatureRequestFilesWithHttpInfo(string $signature_request_id, return [ ObjectSerializer::deserialize($content, '\SplFileObject', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\SplFileObject'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1912,9 +1977,11 @@ public function signatureRequestFilesWithHttpInfo(string $signature_request_id, return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1927,6 +1994,7 @@ public function signatureRequestFilesWithHttpInfo(string $signature_request_id, ); $e->setResponseObject($data); break; + } throw $e; } @@ -1937,15 +2005,15 @@ public function signatureRequestFilesWithHttpInfo(string $signature_request_id, * * Download Files * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFiles. This method will eventually become unavailable */ - public function signatureRequestFilesAsync(string $signature_request_id, string $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) + public function signatureRequestFilesAsync($signature_request_id, $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) { return $this->signatureRequestFilesAsyncWithHttpInfo($signature_request_id, $file_type, $contentType) ->then( @@ -1960,15 +2028,15 @@ function ($response) { * * Download Files * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFiles. This method will eventually become unavailable */ - public function signatureRequestFilesAsyncWithHttpInfo(string $signature_request_id, string $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) + public function signatureRequestFilesAsyncWithHttpInfo($signature_request_id, $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) { $returnType = '\SplFileObject'; $request = $this->signatureRequestFilesRequest($signature_request_id, $file_type, $contentType); @@ -1978,9 +2046,9 @@ public function signatureRequestFilesAsyncWithHttpInfo(string $signature_request ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1989,7 +2057,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -2003,7 +2071,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2012,23 +2080,26 @@ function ($exception) { /** * Create request for operation 'signatureRequestFiles' * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestFiles. This method will eventually become unavailable */ - public function signatureRequestFilesRequest(string $signature_request_id, string $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) + public function signatureRequestFilesRequest($signature_request_id, $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) { + // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestFiles' ); } + + $resourcePath = '/signature_request/files/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -2046,17 +2117,19 @@ public function signatureRequestFilesRequest(string $signature_request_id, strin false // required ) ?? []); + // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{signature_request_id}', + '{' . 'signature_request_id' . '}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/zip', 'application/json'], + $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/zip', 'application/json', ], $contentType, $multipart ); @@ -2070,7 +2143,7 @@ public function signatureRequestFilesRequest(string $signature_request_id, strin foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -2084,8 +2157,9 @@ public function signatureRequestFilesRequest(string $signature_request_id, strin } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2128,13 +2202,13 @@ public function signatureRequestFilesRequest(string $signature_request_id, strin * * Download Files as Data Uri * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * - * @return Model\FileResponseDataUri - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FileResponseDataUri|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestFilesAsDataUri(string $signature_request_id) + public function signatureRequestFilesAsDataUri($signature_request_id) { list($response) = $this->signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id); return $response; @@ -2145,15 +2219,15 @@ public function signatureRequestFilesAsDataUri(string $signature_request_id) * * Download Files as Data Uri * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * - * @return array of Model\FileResponseDataUri, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FileResponseDataUri|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestFilesAsDataUri. This method will eventually become unavailable */ - public function signatureRequestFilesAsDataUriWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) + public function signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) { $request = $this->signatureRequestFilesAsDataUriRequest($signature_request_id, $contentType); @@ -2165,14 +2239,14 @@ public function signatureRequestFilesAsDataUriWithHttpInfo(string $signature_req } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -2185,14 +2259,14 @@ public function signatureRequestFilesAsDataUriWithHttpInfo(string $signature_req sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2201,17 +2275,18 @@ public function signatureRequestFilesAsDataUriWithHttpInfo(string $signature_req if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FileResponseDataUri' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FileResponseDataUri' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2228,19 +2303,20 @@ public function signatureRequestFilesAsDataUriWithHttpInfo(string $signature_req return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FileResponseDataUri', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FileResponseDataUri'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2257,9 +2333,11 @@ public function signatureRequestFilesAsDataUriWithHttpInfo(string $signature_req return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2272,6 +2350,7 @@ public function signatureRequestFilesAsDataUriWithHttpInfo(string $signature_req ); $e->setResponseObject($data); break; + } throw $e; } @@ -2282,14 +2361,14 @@ public function signatureRequestFilesAsDataUriWithHttpInfo(string $signature_req * * Download Files as Data Uri * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsDataUri. This method will eventually become unavailable */ - public function signatureRequestFilesAsDataUriAsync(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) + public function signatureRequestFilesAsDataUriAsync($signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) { return $this->signatureRequestFilesAsDataUriAsyncWithHttpInfo($signature_request_id, $contentType) ->then( @@ -2304,14 +2383,14 @@ function ($response) { * * Download Files as Data Uri * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsDataUri. This method will eventually become unavailable */ - public function signatureRequestFilesAsDataUriAsyncWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) + public function signatureRequestFilesAsDataUriAsyncWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) { $returnType = '\Dropbox\Sign\Model\FileResponseDataUri'; $request = $this->signatureRequestFilesAsDataUriRequest($signature_request_id, $contentType); @@ -2321,9 +2400,9 @@ public function signatureRequestFilesAsDataUriAsyncWithHttpInfo(string $signatur ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2332,7 +2411,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -2346,7 +2425,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2355,22 +2434,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestFilesAsDataUri' * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestFilesAsDataUri. This method will eventually become unavailable */ - public function signatureRequestFilesAsDataUriRequest(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) + public function signatureRequestFilesAsDataUriRequest($signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) { + // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestFilesAsDataUri' ); } + $resourcePath = '/signature_request/files_as_data_uri/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -2378,17 +2459,20 @@ public function signatureRequestFilesAsDataUriRequest(string $signature_request_ $httpBody = ''; $multipart = false; + + // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{signature_request_id}', + '{' . 'signature_request_id' . '}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -2402,7 +2486,7 @@ public function signatureRequestFilesAsDataUriRequest(string $signature_request_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -2416,8 +2500,9 @@ public function signatureRequestFilesAsDataUriRequest(string $signature_request_ } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2460,14 +2545,14 @@ public function signatureRequestFilesAsDataUriRequest(string $signature_request_ * * Download Files as File Url * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * - * @return Model\FileResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FileResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestFilesAsFileUrl(string $signature_request_id, int $force_download = 1) + public function signatureRequestFilesAsFileUrl($signature_request_id, $force_download = 1) { list($response) = $this->signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id, $force_download); return $response; @@ -2478,16 +2563,16 @@ public function signatureRequestFilesAsFileUrl(string $signature_request_id, int * * Download Files as File Url * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation * - * @return array of Model\FileResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FileResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestFilesAsFileUrl. This method will eventually become unavailable */ - public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_request_id, int $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) + public function signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id, $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) { $request = $this->signatureRequestFilesAsFileUrlRequest($signature_request_id, $force_download, $contentType); @@ -2499,14 +2584,14 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_req } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -2519,14 +2604,14 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_req sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2535,17 +2620,18 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_req if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FileResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FileResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2562,19 +2648,20 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_req return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FileResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FileResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2591,9 +2678,11 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_req return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2606,6 +2695,7 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_req ); $e->setResponseObject($data); break; + } throw $e; } @@ -2616,15 +2706,15 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_req * * Download Files as File Url * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsFileUrl. This method will eventually become unavailable */ - public function signatureRequestFilesAsFileUrlAsync(string $signature_request_id, int $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) + public function signatureRequestFilesAsFileUrlAsync($signature_request_id, $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) { return $this->signatureRequestFilesAsFileUrlAsyncWithHttpInfo($signature_request_id, $force_download, $contentType) ->then( @@ -2639,15 +2729,15 @@ function ($response) { * * Download Files as File Url * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsFileUrl. This method will eventually become unavailable */ - public function signatureRequestFilesAsFileUrlAsyncWithHttpInfo(string $signature_request_id, int $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) + public function signatureRequestFilesAsFileUrlAsyncWithHttpInfo($signature_request_id, $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) { $returnType = '\Dropbox\Sign\Model\FileResponse'; $request = $this->signatureRequestFilesAsFileUrlRequest($signature_request_id, $force_download, $contentType); @@ -2657,9 +2747,9 @@ public function signatureRequestFilesAsFileUrlAsyncWithHttpInfo(string $signatur ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2668,7 +2758,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -2682,7 +2772,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2691,23 +2781,26 @@ function ($exception) { /** * Create request for operation 'signatureRequestFilesAsFileUrl' * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestFilesAsFileUrl. This method will eventually become unavailable */ - public function signatureRequestFilesAsFileUrlRequest(string $signature_request_id, int $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) + public function signatureRequestFilesAsFileUrlRequest($signature_request_id, $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) { + // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestFilesAsFileUrl' ); } + + $resourcePath = '/signature_request/files_as_file_url/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -2725,17 +2818,19 @@ public function signatureRequestFilesAsFileUrlRequest(string $signature_request_ false // required ) ?? []); + // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{signature_request_id}', + '{' . 'signature_request_id' . '}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -2749,7 +2844,7 @@ public function signatureRequestFilesAsFileUrlRequest(string $signature_request_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -2763,8 +2858,9 @@ public function signatureRequestFilesAsFileUrlRequest(string $signature_request_ } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2807,13 +2903,13 @@ public function signatureRequestFilesAsFileUrlRequest(string $signature_request_ * * Get Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * - * @return Model\SignatureRequestGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestGet(string $signature_request_id) + public function signatureRequestGet($signature_request_id) { list($response) = $this->signatureRequestGetWithHttpInfo($signature_request_id); return $response; @@ -2824,15 +2920,15 @@ public function signatureRequestGet(string $signature_request_id) * * Get Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * - * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestGet. This method will eventually become unavailable */ - public function signatureRequestGetWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) + public function signatureRequestGetWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) { $request = $this->signatureRequestGetRequest($signature_request_id, $contentType); @@ -2844,14 +2940,14 @@ public function signatureRequestGetWithHttpInfo(string $signature_request_id, st } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -2864,14 +2960,14 @@ public function signatureRequestGetWithHttpInfo(string $signature_request_id, st sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2880,17 +2976,18 @@ public function signatureRequestGetWithHttpInfo(string $signature_request_id, st if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2907,19 +3004,20 @@ public function signatureRequestGetWithHttpInfo(string $signature_request_id, st return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2936,9 +3034,11 @@ public function signatureRequestGetWithHttpInfo(string $signature_request_id, st return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2951,6 +3051,7 @@ public function signatureRequestGetWithHttpInfo(string $signature_request_id, st ); $e->setResponseObject($data); break; + } throw $e; } @@ -2961,14 +3062,14 @@ public function signatureRequestGetWithHttpInfo(string $signature_request_id, st * * Get Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestGet. This method will eventually become unavailable */ - public function signatureRequestGetAsync(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) + public function signatureRequestGetAsync($signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) { return $this->signatureRequestGetAsyncWithHttpInfo($signature_request_id, $contentType) ->then( @@ -2983,14 +3084,14 @@ function ($response) { * * Get Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestGet. This method will eventually become unavailable */ - public function signatureRequestGetAsyncWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) + public function signatureRequestGetAsyncWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestGetRequest($signature_request_id, $contentType); @@ -3000,9 +3101,9 @@ public function signatureRequestGetAsyncWithHttpInfo(string $signature_request_i ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3011,7 +3112,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -3025,7 +3126,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -3034,22 +3135,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestGet' * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestGet. This method will eventually become unavailable */ - public function signatureRequestGetRequest(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) + public function signatureRequestGetRequest($signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) { + // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestGet' ); } + $resourcePath = '/signature_request/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -3057,17 +3160,20 @@ public function signatureRequestGetRequest(string $signature_request_id, string $httpBody = ''; $multipart = false; + + // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{signature_request_id}', + '{' . 'signature_request_id' . '}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -3081,7 +3187,7 @@ public function signatureRequestGetRequest(string $signature_request_id, string foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -3095,8 +3201,9 @@ public function signatureRequestGetRequest(string $signature_request_id, string } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3139,16 +3246,16 @@ public function signatureRequestGetRequest(string $signature_request_id, string * * List Signature Requests * - * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) + * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) * - * @return Model\SignatureRequestListResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\SignatureRequestListResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestList(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null) + public function signatureRequestList($account_id = null, $page = 1, $page_size = 20, $query = null) { list($response) = $this->signatureRequestListWithHttpInfo($account_id, $page, $page_size, $query); return $response; @@ -3159,18 +3266,18 @@ public function signatureRequestList(string $account_id = null, int $page = 1, i * * List Signature Requests * - * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation + * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation * - * @return array of Model\SignatureRequestListResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\SignatureRequestListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestList. This method will eventually become unavailable */ - public function signatureRequestListWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) + public function signatureRequestListWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) { $request = $this->signatureRequestListRequest($account_id, $page, $page_size, $query, $contentType); @@ -3182,14 +3289,14 @@ public function signatureRequestListWithHttpInfo(string $account_id = null, int } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -3202,14 +3309,14 @@ public function signatureRequestListWithHttpInfo(string $account_id = null, int sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3218,17 +3325,18 @@ public function signatureRequestListWithHttpInfo(string $account_id = null, int if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestListResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3245,19 +3353,20 @@ public function signatureRequestListWithHttpInfo(string $account_id = null, int return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestListResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\SignatureRequestListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3274,9 +3383,11 @@ public function signatureRequestListWithHttpInfo(string $account_id = null, int return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3289,6 +3400,7 @@ public function signatureRequestListWithHttpInfo(string $account_id = null, int ); $e->setResponseObject($data); break; + } throw $e; } @@ -3299,17 +3411,17 @@ public function signatureRequestListWithHttpInfo(string $account_id = null, int * * List Signature Requests * - * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation + * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestList. This method will eventually become unavailable */ - public function signatureRequestListAsync(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) + public function signatureRequestListAsync($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) { return $this->signatureRequestListAsyncWithHttpInfo($account_id, $page, $page_size, $query, $contentType) ->then( @@ -3324,17 +3436,17 @@ function ($response) { * * List Signature Requests * - * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation + * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestList. This method will eventually become unavailable */ - public function signatureRequestListAsyncWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) + public function signatureRequestListAsyncWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestListResponse'; $request = $this->signatureRequestListRequest($account_id, $page, $page_size, $query, $contentType); @@ -3344,9 +3456,9 @@ public function signatureRequestListAsyncWithHttpInfo(string $account_id = null, ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3355,7 +3467,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -3369,7 +3481,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -3378,18 +3490,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestList' * - * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation + * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestList. This method will eventually become unavailable */ - public function signatureRequestListRequest(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) + public function signatureRequestListRequest($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) { + + + + + + $resourcePath = '/signature_request/list'; $formParams = []; $queryParams = []; @@ -3434,8 +3552,11 @@ public function signatureRequestListRequest(string $account_id = null, int $page false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -3449,7 +3570,7 @@ public function signatureRequestListRequest(string $account_id = null, int $page foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -3463,8 +3584,9 @@ public function signatureRequestListRequest(string $account_id = null, int $page } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3507,13 +3629,13 @@ public function signatureRequestListRequest(string $account_id = null, int $page * * Release On-Hold Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to release. (required) + * @param string $signature_request_id The id of the SignatureRequest to release. (required) * - * @return Model\SignatureRequestGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestReleaseHold(string $signature_request_id) + public function signatureRequestReleaseHold($signature_request_id) { list($response) = $this->signatureRequestReleaseHoldWithHttpInfo($signature_request_id); return $response; @@ -3524,15 +3646,15 @@ public function signatureRequestReleaseHold(string $signature_request_id) * * Release On-Hold Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to release. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to release. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * - * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestReleaseHold. This method will eventually become unavailable */ - public function signatureRequestReleaseHoldWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) + public function signatureRequestReleaseHoldWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) { $request = $this->signatureRequestReleaseHoldRequest($signature_request_id, $contentType); @@ -3544,14 +3666,14 @@ public function signatureRequestReleaseHoldWithHttpInfo(string $signature_reques } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -3564,14 +3686,14 @@ public function signatureRequestReleaseHoldWithHttpInfo(string $signature_reques sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3580,17 +3702,18 @@ public function signatureRequestReleaseHoldWithHttpInfo(string $signature_reques if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3607,19 +3730,20 @@ public function signatureRequestReleaseHoldWithHttpInfo(string $signature_reques return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3636,9 +3760,11 @@ public function signatureRequestReleaseHoldWithHttpInfo(string $signature_reques return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3651,6 +3777,7 @@ public function signatureRequestReleaseHoldWithHttpInfo(string $signature_reques ); $e->setResponseObject($data); break; + } throw $e; } @@ -3661,14 +3788,14 @@ public function signatureRequestReleaseHoldWithHttpInfo(string $signature_reques * * Release On-Hold Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to release. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to release. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestReleaseHold. This method will eventually become unavailable */ - public function signatureRequestReleaseHoldAsync(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) + public function signatureRequestReleaseHoldAsync($signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) { return $this->signatureRequestReleaseHoldAsyncWithHttpInfo($signature_request_id, $contentType) ->then( @@ -3683,14 +3810,14 @@ function ($response) { * * Release On-Hold Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to release. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to release. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestReleaseHold. This method will eventually become unavailable */ - public function signatureRequestReleaseHoldAsyncWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) + public function signatureRequestReleaseHoldAsyncWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestReleaseHoldRequest($signature_request_id, $contentType); @@ -3700,9 +3827,9 @@ public function signatureRequestReleaseHoldAsyncWithHttpInfo(string $signature_r ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3711,7 +3838,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -3725,7 +3852,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -3734,22 +3861,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestReleaseHold' * - * @param string $signature_request_id The id of the SignatureRequest to release. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to release. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestReleaseHold. This method will eventually become unavailable */ - public function signatureRequestReleaseHoldRequest(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) + public function signatureRequestReleaseHoldRequest($signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) { + // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestReleaseHold' ); } + $resourcePath = '/signature_request/release_hold/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -3757,17 +3886,20 @@ public function signatureRequestReleaseHoldRequest(string $signature_request_id, $httpBody = ''; $multipart = false; + + // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{signature_request_id}', + '{' . 'signature_request_id' . '}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -3781,7 +3913,7 @@ public function signatureRequestReleaseHoldRequest(string $signature_request_id, foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -3795,8 +3927,9 @@ public function signatureRequestReleaseHoldRequest(string $signature_request_id, } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3839,14 +3972,14 @@ public function signatureRequestReleaseHoldRequest(string $signature_request_id, * * Send Request Reminder * - * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) - * @param Model\SignatureRequestRemindRequest $signature_request_remind_request signature_request_remind_request (required) + * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) + * @param \Dropbox\Sign\Model\SignatureRequestRemindRequest $signature_request_remind_request signature_request_remind_request (required) * - * @return Model\SignatureRequestGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestRemind(string $signature_request_id, Model\SignatureRequestRemindRequest $signature_request_remind_request) + public function signatureRequestRemind($signature_request_id, $signature_request_remind_request) { list($response) = $this->signatureRequestRemindWithHttpInfo($signature_request_id, $signature_request_remind_request); return $response; @@ -3857,16 +3990,16 @@ public function signatureRequestRemind(string $signature_request_id, Model\Signa * * Send Request Reminder * - * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) - * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) + * @param \Dropbox\Sign\Model\SignatureRequestRemindRequest $signature_request_remind_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation * - * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestRemind. This method will eventually become unavailable */ - public function signatureRequestRemindWithHttpInfo(string $signature_request_id, Model\SignatureRequestRemindRequest $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) + public function signatureRequestRemindWithHttpInfo($signature_request_id, $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) { $request = $this->signatureRequestRemindRequest($signature_request_id, $signature_request_remind_request, $contentType); @@ -3878,14 +4011,14 @@ public function signatureRequestRemindWithHttpInfo(string $signature_request_id, } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -3898,14 +4031,14 @@ public function signatureRequestRemindWithHttpInfo(string $signature_request_id, sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3914,17 +4047,18 @@ public function signatureRequestRemindWithHttpInfo(string $signature_request_id, if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3941,19 +4075,20 @@ public function signatureRequestRemindWithHttpInfo(string $signature_request_id, return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3970,9 +4105,11 @@ public function signatureRequestRemindWithHttpInfo(string $signature_request_id, return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3985,6 +4122,7 @@ public function signatureRequestRemindWithHttpInfo(string $signature_request_id, ); $e->setResponseObject($data); break; + } throw $e; } @@ -3995,15 +4133,15 @@ public function signatureRequestRemindWithHttpInfo(string $signature_request_id, * * Send Request Reminder * - * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) - * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) + * @param \Dropbox\Sign\Model\SignatureRequestRemindRequest $signature_request_remind_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemind. This method will eventually become unavailable */ - public function signatureRequestRemindAsync(string $signature_request_id, Model\SignatureRequestRemindRequest $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) + public function signatureRequestRemindAsync($signature_request_id, $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) { return $this->signatureRequestRemindAsyncWithHttpInfo($signature_request_id, $signature_request_remind_request, $contentType) ->then( @@ -4018,15 +4156,15 @@ function ($response) { * * Send Request Reminder * - * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) - * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) + * @param \Dropbox\Sign\Model\SignatureRequestRemindRequest $signature_request_remind_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemind. This method will eventually become unavailable */ - public function signatureRequestRemindAsyncWithHttpInfo(string $signature_request_id, Model\SignatureRequestRemindRequest $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) + public function signatureRequestRemindAsyncWithHttpInfo($signature_request_id, $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestRemindRequest($signature_request_id, $signature_request_remind_request, $contentType); @@ -4036,9 +4174,9 @@ public function signatureRequestRemindAsyncWithHttpInfo(string $signature_reques ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -4047,7 +4185,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -4061,7 +4199,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -4070,30 +4208,32 @@ function ($exception) { /** * Create request for operation 'signatureRequestRemind' * - * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) - * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) + * @param \Dropbox\Sign\Model\SignatureRequestRemindRequest $signature_request_remind_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestRemind. This method will eventually become unavailable */ - public function signatureRequestRemindRequest(string $signature_request_id, Model\SignatureRequestRemindRequest $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) + public function signatureRequestRemindRequest($signature_request_id, $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) { + // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestRemind' ); } // verify the required parameter 'signature_request_remind_request' is set if ($signature_request_remind_request === null || (is_array($signature_request_remind_request) && count($signature_request_remind_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_remind_request when calling signatureRequestRemind' ); } + $resourcePath = '/signature_request/remind/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -4107,17 +4247,19 @@ public function signatureRequestRemindRequest(string $signature_request_id, Mode $multipart = !empty($formParams); + // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{signature_request_id}', + '{' . 'signature_request_id' . '}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -4125,7 +4267,7 @@ public function signatureRequestRemindRequest(string $signature_request_id, Mode // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_remind_request)); } else { $httpBody = $signature_request_remind_request; @@ -4138,7 +4280,7 @@ public function signatureRequestRemindRequest(string $signature_request_id, Mode foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -4155,8 +4297,9 @@ public function signatureRequestRemindRequest(string $signature_request_id, Mode $payloadHook('multipart', $multipartContents, $signature_request_remind_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -4199,12 +4342,13 @@ public function signatureRequestRemindRequest(string $signature_request_id, Mode * * Remove Signature Request Access * - * @param string $signature_request_id The id of the SignatureRequest to remove. (required) + * @param string $signature_request_id The id of the SignatureRequest to remove. (required) * - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return void */ - public function signatureRequestRemove(string $signature_request_id) + public function signatureRequestRemove($signature_request_id) { $this->signatureRequestRemoveWithHttpInfo($signature_request_id); } @@ -4214,15 +4358,15 @@ public function signatureRequestRemove(string $signature_request_id) * * Remove Signature Request Access * - * @param string $signature_request_id The id of the SignatureRequest to remove. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to remove. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemove. This method will eventually become unavailable */ - public function signatureRequestRemoveWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) + public function signatureRequestRemoveWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) { $request = $this->signatureRequestRemoveRequest($signature_request_id, $contentType); @@ -4234,14 +4378,14 @@ public function signatureRequestRemoveWithHttpInfo(string $signature_request_id, } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -4254,20 +4398,23 @@ public function signatureRequestRemoveWithHttpInfo(string $signature_request_id, sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { + } throw $e; } @@ -4278,14 +4425,14 @@ public function signatureRequestRemoveWithHttpInfo(string $signature_request_id, * * Remove Signature Request Access * - * @param string $signature_request_id The id of the SignatureRequest to remove. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to remove. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemove. This method will eventually become unavailable */ - public function signatureRequestRemoveAsync(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) + public function signatureRequestRemoveAsync($signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) { return $this->signatureRequestRemoveAsyncWithHttpInfo($signature_request_id, $contentType) ->then( @@ -4300,14 +4447,14 @@ function ($response) { * * Remove Signature Request Access * - * @param string $signature_request_id The id of the SignatureRequest to remove. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to remove. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemove. This method will eventually become unavailable */ - public function signatureRequestRemoveAsyncWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) + public function signatureRequestRemoveAsyncWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) { $returnType = ''; $request = $this->signatureRequestRemoveRequest($signature_request_id, $contentType); @@ -4315,7 +4462,7 @@ public function signatureRequestRemoveAsyncWithHttpInfo(string $signature_reques return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) { + function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -4329,7 +4476,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -4338,22 +4485,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestRemove' * - * @param string $signature_request_id The id of the SignatureRequest to remove. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to remove. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestRemove. This method will eventually become unavailable */ - public function signatureRequestRemoveRequest(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) + public function signatureRequestRemoveRequest($signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) { + // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestRemove' ); } + $resourcePath = '/signature_request/remove/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -4361,17 +4510,20 @@ public function signatureRequestRemoveRequest(string $signature_request_id, stri $httpBody = ''; $multipart = false; + + // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{signature_request_id}', + '{' . 'signature_request_id' . '}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -4385,7 +4537,7 @@ public function signatureRequestRemoveRequest(string $signature_request_id, stri foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -4399,8 +4551,9 @@ public function signatureRequestRemoveRequest(string $signature_request_id, stri } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -4439,13 +4592,13 @@ public function signatureRequestRemoveRequest(string $signature_request_id, stri * * Send Signature Request * - * @param Model\SignatureRequestSendRequest $signature_request_send_request signature_request_send_request (required) + * @param \Dropbox\Sign\Model\SignatureRequestSendRequest $signature_request_send_request signature_request_send_request (required) * - * @return Model\SignatureRequestGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestSend(Model\SignatureRequestSendRequest $signature_request_send_request) + public function signatureRequestSend($signature_request_send_request) { list($response) = $this->signatureRequestSendWithHttpInfo($signature_request_send_request); return $response; @@ -4456,15 +4609,15 @@ public function signatureRequestSend(Model\SignatureRequestSendRequest $signatur * * Send Signature Request * - * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestSendRequest $signature_request_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * - * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestSend. This method will eventually become unavailable */ - public function signatureRequestSendWithHttpInfo(Model\SignatureRequestSendRequest $signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) + public function signatureRequestSendWithHttpInfo($signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) { $request = $this->signatureRequestSendRequest($signature_request_send_request, $contentType); @@ -4476,14 +4629,14 @@ public function signatureRequestSendWithHttpInfo(Model\SignatureRequestSendReque } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -4496,14 +4649,14 @@ public function signatureRequestSendWithHttpInfo(Model\SignatureRequestSendReque sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -4512,17 +4665,18 @@ public function signatureRequestSendWithHttpInfo(Model\SignatureRequestSendReque if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -4539,19 +4693,20 @@ public function signatureRequestSendWithHttpInfo(Model\SignatureRequestSendReque return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -4568,9 +4723,11 @@ public function signatureRequestSendWithHttpInfo(Model\SignatureRequestSendReque return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -4583,6 +4740,7 @@ public function signatureRequestSendWithHttpInfo(Model\SignatureRequestSendReque ); $e->setResponseObject($data); break; + } throw $e; } @@ -4593,14 +4751,14 @@ public function signatureRequestSendWithHttpInfo(Model\SignatureRequestSendReque * * Send Signature Request * - * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestSendRequest $signature_request_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSend. This method will eventually become unavailable */ - public function signatureRequestSendAsync(Model\SignatureRequestSendRequest $signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) + public function signatureRequestSendAsync($signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) { return $this->signatureRequestSendAsyncWithHttpInfo($signature_request_send_request, $contentType) ->then( @@ -4615,14 +4773,14 @@ function ($response) { * * Send Signature Request * - * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestSendRequest $signature_request_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSend. This method will eventually become unavailable */ - public function signatureRequestSendAsyncWithHttpInfo(Model\SignatureRequestSendRequest $signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) + public function signatureRequestSendAsyncWithHttpInfo($signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestSendRequest($signature_request_send_request, $contentType); @@ -4632,9 +4790,9 @@ public function signatureRequestSendAsyncWithHttpInfo(Model\SignatureRequestSend ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -4643,7 +4801,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -4657,7 +4815,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -4666,22 +4824,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestSend' * - * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestSendRequest $signature_request_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestSend. This method will eventually become unavailable */ - public function signatureRequestSendRequest(Model\SignatureRequestSendRequest $signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) + public function signatureRequestSendRequest($signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) { + // verify the required parameter 'signature_request_send_request' is set if ($signature_request_send_request === null || (is_array($signature_request_send_request) && count($signature_request_send_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_send_request when calling signatureRequestSend' ); } + $resourcePath = '/signature_request/send'; $formParams = []; $queryParams = []; @@ -4695,8 +4855,11 @@ public function signatureRequestSendRequest(Model\SignatureRequestSendRequest $s $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -4704,7 +4867,7 @@ public function signatureRequestSendRequest(Model\SignatureRequestSendRequest $s // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_send_request)); } else { $httpBody = $signature_request_send_request; @@ -4717,7 +4880,7 @@ public function signatureRequestSendRequest(Model\SignatureRequestSendRequest $s foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -4734,8 +4897,9 @@ public function signatureRequestSendRequest(Model\SignatureRequestSendRequest $s $payloadHook('multipart', $multipartContents, $signature_request_send_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -4778,13 +4942,13 @@ public function signatureRequestSendRequest(Model\SignatureRequestSendRequest $s * * Send with Template * - * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request signature_request_send_with_template_request (required) + * @param \Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request signature_request_send_with_template_request (required) * - * @return Model\SignatureRequestGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestSendWithTemplate(Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request) + public function signatureRequestSendWithTemplate($signature_request_send_with_template_request) { list($response) = $this->signatureRequestSendWithTemplateWithHttpInfo($signature_request_send_with_template_request); return $response; @@ -4795,15 +4959,15 @@ public function signatureRequestSendWithTemplate(Model\SignatureRequestSendWithT * * Send with Template * - * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * - * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestSendWithTemplateWithHttpInfo(Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) + public function signatureRequestSendWithTemplateWithHttpInfo($signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) { $request = $this->signatureRequestSendWithTemplateRequest($signature_request_send_with_template_request, $contentType); @@ -4815,14 +4979,14 @@ public function signatureRequestSendWithTemplateWithHttpInfo(Model\SignatureRequ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -4835,14 +4999,14 @@ public function signatureRequestSendWithTemplateWithHttpInfo(Model\SignatureRequ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -4851,17 +5015,18 @@ public function signatureRequestSendWithTemplateWithHttpInfo(Model\SignatureRequ if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -4878,19 +5043,20 @@ public function signatureRequestSendWithTemplateWithHttpInfo(Model\SignatureRequ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -4907,9 +5073,11 @@ public function signatureRequestSendWithTemplateWithHttpInfo(Model\SignatureRequ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -4922,6 +5090,7 @@ public function signatureRequestSendWithTemplateWithHttpInfo(Model\SignatureRequ ); $e->setResponseObject($data); break; + } throw $e; } @@ -4932,14 +5101,14 @@ public function signatureRequestSendWithTemplateWithHttpInfo(Model\SignatureRequ * * Send with Template * - * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestSendWithTemplateAsync(Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) + public function signatureRequestSendWithTemplateAsync($signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) { return $this->signatureRequestSendWithTemplateAsyncWithHttpInfo($signature_request_send_with_template_request, $contentType) ->then( @@ -4954,14 +5123,14 @@ function ($response) { * * Send with Template * - * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestSendWithTemplateAsyncWithHttpInfo(Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) + public function signatureRequestSendWithTemplateAsyncWithHttpInfo($signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestSendWithTemplateRequest($signature_request_send_with_template_request, $contentType); @@ -4971,9 +5140,9 @@ public function signatureRequestSendWithTemplateAsyncWithHttpInfo(Model\Signatur ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -4982,7 +5151,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -4996,7 +5165,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -5005,22 +5174,24 @@ function ($exception) { /** * Create request for operation 'signatureRequestSendWithTemplate' * - * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestSendWithTemplateRequest(Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) + public function signatureRequestSendWithTemplateRequest($signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) { + // verify the required parameter 'signature_request_send_with_template_request' is set if ($signature_request_send_with_template_request === null || (is_array($signature_request_send_with_template_request) && count($signature_request_send_with_template_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_send_with_template_request when calling signatureRequestSendWithTemplate' ); } + $resourcePath = '/signature_request/send_with_template'; $formParams = []; $queryParams = []; @@ -5034,8 +5205,11 @@ public function signatureRequestSendWithTemplateRequest(Model\SignatureRequestSe $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -5043,7 +5217,7 @@ public function signatureRequestSendWithTemplateRequest(Model\SignatureRequestSe // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_send_with_template_request)); } else { $httpBody = $signature_request_send_with_template_request; @@ -5056,7 +5230,7 @@ public function signatureRequestSendWithTemplateRequest(Model\SignatureRequestSe foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -5073,8 +5247,9 @@ public function signatureRequestSendWithTemplateRequest(Model\SignatureRequestSe $payloadHook('multipart', $multipartContents, $signature_request_send_with_template_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -5117,14 +5292,14 @@ public function signatureRequestSendWithTemplateRequest(Model\SignatureRequestSe * * Update Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to update. (required) - * @param Model\SignatureRequestUpdateRequest $signature_request_update_request signature_request_update_request (required) + * @param string $signature_request_id The id of the SignatureRequest to update. (required) + * @param \Dropbox\Sign\Model\SignatureRequestUpdateRequest $signature_request_update_request signature_request_update_request (required) * - * @return Model\SignatureRequestGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function signatureRequestUpdate(string $signature_request_id, Model\SignatureRequestUpdateRequest $signature_request_update_request) + public function signatureRequestUpdate($signature_request_id, $signature_request_update_request) { list($response) = $this->signatureRequestUpdateWithHttpInfo($signature_request_id, $signature_request_update_request); return $response; @@ -5135,16 +5310,16 @@ public function signatureRequestUpdate(string $signature_request_id, Model\Signa * * Update Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to update. (required) - * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to update. (required) + * @param \Dropbox\Sign\Model\SignatureRequestUpdateRequest $signature_request_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation * - * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::signatureRequestUpdate. This method will eventually become unavailable */ - public function signatureRequestUpdateWithHttpInfo(string $signature_request_id, Model\SignatureRequestUpdateRequest $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) + public function signatureRequestUpdateWithHttpInfo($signature_request_id, $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) { $request = $this->signatureRequestUpdateRequest($signature_request_id, $signature_request_update_request, $contentType); @@ -5156,14 +5331,14 @@ public function signatureRequestUpdateWithHttpInfo(string $signature_request_id, } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -5176,14 +5351,14 @@ public function signatureRequestUpdateWithHttpInfo(string $signature_request_id, sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -5192,17 +5367,18 @@ public function signatureRequestUpdateWithHttpInfo(string $signature_request_id, if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -5219,19 +5395,20 @@ public function signatureRequestUpdateWithHttpInfo(string $signature_request_id, return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -5248,9 +5425,11 @@ public function signatureRequestUpdateWithHttpInfo(string $signature_request_id, return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -5263,6 +5442,7 @@ public function signatureRequestUpdateWithHttpInfo(string $signature_request_id, ); $e->setResponseObject($data); break; + } throw $e; } @@ -5273,15 +5453,15 @@ public function signatureRequestUpdateWithHttpInfo(string $signature_request_id, * * Update Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to update. (required) - * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to update. (required) + * @param \Dropbox\Sign\Model\SignatureRequestUpdateRequest $signature_request_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestUpdate. This method will eventually become unavailable */ - public function signatureRequestUpdateAsync(string $signature_request_id, Model\SignatureRequestUpdateRequest $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) + public function signatureRequestUpdateAsync($signature_request_id, $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) { return $this->signatureRequestUpdateAsyncWithHttpInfo($signature_request_id, $signature_request_update_request, $contentType) ->then( @@ -5296,15 +5476,15 @@ function ($response) { * * Update Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to update. (required) - * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to update. (required) + * @param \Dropbox\Sign\Model\SignatureRequestUpdateRequest $signature_request_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestUpdate. This method will eventually become unavailable */ - public function signatureRequestUpdateAsyncWithHttpInfo(string $signature_request_id, Model\SignatureRequestUpdateRequest $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) + public function signatureRequestUpdateAsyncWithHttpInfo($signature_request_id, $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestUpdateRequest($signature_request_id, $signature_request_update_request, $contentType); @@ -5314,9 +5494,9 @@ public function signatureRequestUpdateAsyncWithHttpInfo(string $signature_reques ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -5325,7 +5505,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -5339,7 +5519,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -5348,30 +5528,32 @@ function ($exception) { /** * Create request for operation 'signatureRequestUpdate' * - * @param string $signature_request_id The id of the SignatureRequest to update. (required) - * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to update. (required) + * @param \Dropbox\Sign\Model\SignatureRequestUpdateRequest $signature_request_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::signatureRequestUpdate. This method will eventually become unavailable */ - public function signatureRequestUpdateRequest(string $signature_request_id, Model\SignatureRequestUpdateRequest $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) + public function signatureRequestUpdateRequest($signature_request_id, $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) { + // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestUpdate' ); } // verify the required parameter 'signature_request_update_request' is set if ($signature_request_update_request === null || (is_array($signature_request_update_request) && count($signature_request_update_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_update_request when calling signatureRequestUpdate' ); } + $resourcePath = '/signature_request/update/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -5385,17 +5567,19 @@ public function signatureRequestUpdateRequest(string $signature_request_id, Mode $multipart = !empty($formParams); + // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{signature_request_id}', + '{' . 'signature_request_id' . '}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -5403,7 +5587,7 @@ public function signatureRequestUpdateRequest(string $signature_request_id, Mode // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_update_request)); } else { $httpBody = $signature_request_update_request; @@ -5416,7 +5600,7 @@ public function signatureRequestUpdateRequest(string $signature_request_id, Mode foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -5433,8 +5617,9 @@ public function signatureRequestUpdateRequest(string $signature_request_id, Mode $payloadHook('multipart', $multipartContents, $signature_request_update_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -5475,8 +5660,8 @@ public function signatureRequestUpdateRequest(string $signature_request_id, Mode /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -5484,7 +5669,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -5500,8 +5685,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -5511,9 +5696,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -5532,8 +5717,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/TeamApi.php b/sdks/php/src/Api/TeamApi.php index ec599b4ac..653db9fdb 100644 --- a/sdks/php/src/Api/TeamApi.php +++ b/sdks/php/src/Api/TeamApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,34 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; /** * TeamApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class TeamApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'teamAddMember' => [ 'application/json', @@ -103,13 +110,16 @@ class TeamApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -123,7 +133,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -160,14 +170,14 @@ public function getResponse() * * Add User to Team * - * @param Model\TeamAddMemberRequest $team_add_member_request team_add_member_request (required) - * @param string $team_id The id of the team. (optional) + * @param \Dropbox\Sign\Model\TeamAddMemberRequest $team_add_member_request team_add_member_request (required) + * @param string $team_id The id of the team. (optional) * - * @return Model\TeamGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function teamAddMember(Model\TeamAddMemberRequest $team_add_member_request, string $team_id = null) + public function teamAddMember($team_add_member_request, $team_id = null) { list($response) = $this->teamAddMemberWithHttpInfo($team_add_member_request, $team_id); return $response; @@ -178,16 +188,16 @@ public function teamAddMember(Model\TeamAddMemberRequest $team_add_member_reques * * Add User to Team * - * @param Model\TeamAddMemberRequest $team_add_member_request (required) - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamAddMemberRequest $team_add_member_request (required) + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation * - * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::teamAddMember. This method will eventually become unavailable */ - public function teamAddMemberWithHttpInfo(Model\TeamAddMemberRequest $team_add_member_request, string $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) + public function teamAddMemberWithHttpInfo($team_add_member_request, $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) { $request = $this->teamAddMemberRequest($team_add_member_request, $team_id, $contentType); @@ -199,14 +209,14 @@ public function teamAddMemberWithHttpInfo(Model\TeamAddMemberRequest $team_add_m } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -219,14 +229,14 @@ public function teamAddMemberWithHttpInfo(Model\TeamAddMemberRequest $team_add_m sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -235,17 +245,18 @@ public function teamAddMemberWithHttpInfo(Model\TeamAddMemberRequest $team_add_m if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TeamGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -262,19 +273,20 @@ public function teamAddMemberWithHttpInfo(Model\TeamAddMemberRequest $team_add_m return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -291,9 +303,11 @@ public function teamAddMemberWithHttpInfo(Model\TeamAddMemberRequest $team_add_m return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -306,6 +320,7 @@ public function teamAddMemberWithHttpInfo(Model\TeamAddMemberRequest $team_add_m ); $e->setResponseObject($data); break; + } throw $e; } @@ -316,15 +331,15 @@ public function teamAddMemberWithHttpInfo(Model\TeamAddMemberRequest $team_add_m * * Add User to Team * - * @param Model\TeamAddMemberRequest $team_add_member_request (required) - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamAddMemberRequest $team_add_member_request (required) + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamAddMember. This method will eventually become unavailable */ - public function teamAddMemberAsync(Model\TeamAddMemberRequest $team_add_member_request, string $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) + public function teamAddMemberAsync($team_add_member_request, $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) { return $this->teamAddMemberAsyncWithHttpInfo($team_add_member_request, $team_id, $contentType) ->then( @@ -339,15 +354,15 @@ function ($response) { * * Add User to Team * - * @param Model\TeamAddMemberRequest $team_add_member_request (required) - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamAddMemberRequest $team_add_member_request (required) + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamAddMember. This method will eventually become unavailable */ - public function teamAddMemberAsyncWithHttpInfo(Model\TeamAddMemberRequest $team_add_member_request, string $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) + public function teamAddMemberAsyncWithHttpInfo($team_add_member_request, $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) { $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; $request = $this->teamAddMemberRequest($team_add_member_request, $team_id, $contentType); @@ -357,9 +372,9 @@ public function teamAddMemberAsyncWithHttpInfo(Model\TeamAddMemberRequest $team_ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -368,7 +383,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -382,7 +397,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -391,23 +406,26 @@ function ($exception) { /** * Create request for operation 'teamAddMember' * - * @param Model\TeamAddMemberRequest $team_add_member_request (required) - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamAddMemberRequest $team_add_member_request (required) + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::teamAddMember. This method will eventually become unavailable */ - public function teamAddMemberRequest(Model\TeamAddMemberRequest $team_add_member_request, string $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) + public function teamAddMemberRequest($team_add_member_request, $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) { + // verify the required parameter 'team_add_member_request' is set if ($team_add_member_request === null || (is_array($team_add_member_request) && count($team_add_member_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $team_add_member_request when calling teamAddMember' ); } + + $resourcePath = '/team/add_member'; $formParams = []; $queryParams = []; @@ -430,8 +448,11 @@ public function teamAddMemberRequest(Model\TeamAddMemberRequest $team_add_member false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -439,7 +460,7 @@ public function teamAddMemberRequest(Model\TeamAddMemberRequest $team_add_member // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($team_add_member_request)); } else { $httpBody = $team_add_member_request; @@ -452,7 +473,7 @@ public function teamAddMemberRequest(Model\TeamAddMemberRequest $team_add_member foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -469,8 +490,9 @@ public function teamAddMemberRequest(Model\TeamAddMemberRequest $team_add_member $payloadHook('multipart', $multipartContents, $team_add_member_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -513,13 +535,13 @@ public function teamAddMemberRequest(Model\TeamAddMemberRequest $team_add_member * * Create Team * - * @param Model\TeamCreateRequest $team_create_request team_create_request (required) + * @param \Dropbox\Sign\Model\TeamCreateRequest $team_create_request team_create_request (required) * - * @return Model\TeamGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function teamCreate(Model\TeamCreateRequest $team_create_request) + public function teamCreate($team_create_request) { list($response) = $this->teamCreateWithHttpInfo($team_create_request); return $response; @@ -530,15 +552,15 @@ public function teamCreate(Model\TeamCreateRequest $team_create_request) * * Create Team * - * @param Model\TeamCreateRequest $team_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamCreateRequest $team_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * - * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::teamCreate. This method will eventually become unavailable */ - public function teamCreateWithHttpInfo(Model\TeamCreateRequest $team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) + public function teamCreateWithHttpInfo($team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) { $request = $this->teamCreateRequest($team_create_request, $contentType); @@ -550,14 +572,14 @@ public function teamCreateWithHttpInfo(Model\TeamCreateRequest $team_create_requ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -570,14 +592,14 @@ public function teamCreateWithHttpInfo(Model\TeamCreateRequest $team_create_requ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -586,17 +608,18 @@ public function teamCreateWithHttpInfo(Model\TeamCreateRequest $team_create_requ if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TeamGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -613,19 +636,20 @@ public function teamCreateWithHttpInfo(Model\TeamCreateRequest $team_create_requ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -642,9 +666,11 @@ public function teamCreateWithHttpInfo(Model\TeamCreateRequest $team_create_requ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -657,6 +683,7 @@ public function teamCreateWithHttpInfo(Model\TeamCreateRequest $team_create_requ ); $e->setResponseObject($data); break; + } throw $e; } @@ -667,14 +694,14 @@ public function teamCreateWithHttpInfo(Model\TeamCreateRequest $team_create_requ * * Create Team * - * @param Model\TeamCreateRequest $team_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamCreateRequest $team_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamCreate. This method will eventually become unavailable */ - public function teamCreateAsync(Model\TeamCreateRequest $team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) + public function teamCreateAsync($team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) { return $this->teamCreateAsyncWithHttpInfo($team_create_request, $contentType) ->then( @@ -689,14 +716,14 @@ function ($response) { * * Create Team * - * @param Model\TeamCreateRequest $team_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamCreateRequest $team_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamCreate. This method will eventually become unavailable */ - public function teamCreateAsyncWithHttpInfo(Model\TeamCreateRequest $team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) + public function teamCreateAsyncWithHttpInfo($team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) { $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; $request = $this->teamCreateRequest($team_create_request, $contentType); @@ -706,9 +733,9 @@ public function teamCreateAsyncWithHttpInfo(Model\TeamCreateRequest $team_create ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -717,7 +744,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -731,7 +758,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -740,22 +767,24 @@ function ($exception) { /** * Create request for operation 'teamCreate' * - * @param Model\TeamCreateRequest $team_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamCreateRequest $team_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::teamCreate. This method will eventually become unavailable */ - public function teamCreateRequest(Model\TeamCreateRequest $team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) + public function teamCreateRequest($team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) { + // verify the required parameter 'team_create_request' is set if ($team_create_request === null || (is_array($team_create_request) && count($team_create_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $team_create_request when calling teamCreate' ); } + $resourcePath = '/team/create'; $formParams = []; $queryParams = []; @@ -769,8 +798,11 @@ public function teamCreateRequest(Model\TeamCreateRequest $team_create_request, $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -778,7 +810,7 @@ public function teamCreateRequest(Model\TeamCreateRequest $team_create_request, // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($team_create_request)); } else { $httpBody = $team_create_request; @@ -791,7 +823,7 @@ public function teamCreateRequest(Model\TeamCreateRequest $team_create_request, foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -808,8 +840,9 @@ public function teamCreateRequest(Model\TeamCreateRequest $team_create_request, $payloadHook('multipart', $multipartContents, $team_create_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -852,8 +885,10 @@ public function teamCreateRequest(Model\TeamCreateRequest $team_create_request, * * Delete Team * - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return void */ public function teamDelete() { @@ -865,11 +900,11 @@ public function teamDelete() * * Delete Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamDelete. This method will eventually become unavailable */ public function teamDeleteWithHttpInfo(string $contentType = self::contentTypes['teamDelete'][0]) @@ -884,14 +919,14 @@ public function teamDeleteWithHttpInfo(string $contentType = self::contentTypes[ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -904,20 +939,23 @@ public function teamDeleteWithHttpInfo(string $contentType = self::contentTypes[ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { + } throw $e; } @@ -928,10 +966,10 @@ public function teamDeleteWithHttpInfo(string $contentType = self::contentTypes[ * * Delete Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamDelete. This method will eventually become unavailable */ public function teamDeleteAsync(string $contentType = self::contentTypes['teamDelete'][0]) @@ -949,10 +987,10 @@ function ($response) { * * Delete Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamDelete. This method will eventually become unavailable */ public function teamDeleteAsyncWithHttpInfo(string $contentType = self::contentTypes['teamDelete'][0]) @@ -963,7 +1001,7 @@ public function teamDeleteAsyncWithHttpInfo(string $contentType = self::contentT return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) { + function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -977,7 +1015,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -986,14 +1024,16 @@ function ($exception) { /** * Create request for operation 'teamDelete' * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::teamDelete. This method will eventually become unavailable */ public function teamDeleteRequest(string $contentType = self::contentTypes['teamDelete'][0]) { + + $resourcePath = '/team/destroy'; $formParams = []; $queryParams = []; @@ -1001,8 +1041,12 @@ public function teamDeleteRequest(string $contentType = self::contentTypes['team $httpBody = ''; $multipart = false; + + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1016,7 +1060,7 @@ public function teamDeleteRequest(string $contentType = self::contentTypes['team foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1030,8 +1074,9 @@ public function teamDeleteRequest(string $contentType = self::contentTypes['team } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1074,9 +1119,10 @@ public function teamDeleteRequest(string $contentType = self::contentTypes['team * * Get Team * - * @return Model\TeamGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse */ public function teamGet() { @@ -1089,11 +1135,11 @@ public function teamGet() * * Get Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * - * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::teamGet. This method will eventually become unavailable */ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['teamGet'][0]) @@ -1108,14 +1154,14 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1128,14 +1174,14 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1144,17 +1190,18 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TeamGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1171,19 +1218,20 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1200,9 +1248,11 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1215,6 +1265,7 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te ); $e->setResponseObject($data); break; + } throw $e; } @@ -1225,10 +1276,10 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te * * Get Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamGet. This method will eventually become unavailable */ public function teamGetAsync(string $contentType = self::contentTypes['teamGet'][0]) @@ -1246,10 +1297,10 @@ function ($response) { * * Get Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamGet. This method will eventually become unavailable */ public function teamGetAsyncWithHttpInfo(string $contentType = self::contentTypes['teamGet'][0]) @@ -1262,9 +1313,9 @@ public function teamGetAsyncWithHttpInfo(string $contentType = self::contentType ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1273,7 +1324,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1287,7 +1338,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1296,14 +1347,16 @@ function ($exception) { /** * Create request for operation 'teamGet' * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::teamGet. This method will eventually become unavailable */ public function teamGetRequest(string $contentType = self::contentTypes['teamGet'][0]) { + + $resourcePath = '/team'; $formParams = []; $queryParams = []; @@ -1311,8 +1364,12 @@ public function teamGetRequest(string $contentType = self::contentTypes['teamGet $httpBody = ''; $multipart = false; + + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1326,7 +1383,7 @@ public function teamGetRequest(string $contentType = self::contentTypes['teamGet foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1340,8 +1397,9 @@ public function teamGetRequest(string $contentType = self::contentTypes['teamGet } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1384,13 +1442,13 @@ public function teamGetRequest(string $contentType = self::contentTypes['teamGet * * Get Team Info * - * @param string $team_id The id of the team. (optional) + * @param string $team_id The id of the team. (optional) * - * @return Model\TeamGetInfoResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TeamGetInfoResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function teamInfo(string $team_id = null) + public function teamInfo($team_id = null) { list($response) = $this->teamInfoWithHttpInfo($team_id); return $response; @@ -1401,15 +1459,15 @@ public function teamInfo(string $team_id = null) * * Get Team Info * - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * - * @return array of Model\TeamGetInfoResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TeamGetInfoResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::teamInfo. This method will eventually become unavailable */ - public function teamInfoWithHttpInfo(string $team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) + public function teamInfoWithHttpInfo($team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) { $request = $this->teamInfoRequest($team_id, $contentType); @@ -1421,14 +1479,14 @@ public function teamInfoWithHttpInfo(string $team_id = null, string $contentType } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1441,14 +1499,14 @@ public function teamInfoWithHttpInfo(string $team_id = null, string $contentType sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1457,17 +1515,18 @@ public function teamInfoWithHttpInfo(string $team_id = null, string $contentType if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamGetInfoResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TeamGetInfoResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1484,19 +1543,20 @@ public function teamInfoWithHttpInfo(string $team_id = null, string $contentType return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetInfoResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TeamGetInfoResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1513,9 +1573,11 @@ public function teamInfoWithHttpInfo(string $team_id = null, string $contentType return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1528,6 +1590,7 @@ public function teamInfoWithHttpInfo(string $team_id = null, string $contentType ); $e->setResponseObject($data); break; + } throw $e; } @@ -1538,14 +1601,14 @@ public function teamInfoWithHttpInfo(string $team_id = null, string $contentType * * Get Team Info * - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInfo. This method will eventually become unavailable */ - public function teamInfoAsync(string $team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) + public function teamInfoAsync($team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) { return $this->teamInfoAsyncWithHttpInfo($team_id, $contentType) ->then( @@ -1560,14 +1623,14 @@ function ($response) { * * Get Team Info * - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInfo. This method will eventually become unavailable */ - public function teamInfoAsyncWithHttpInfo(string $team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) + public function teamInfoAsyncWithHttpInfo($team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) { $returnType = '\Dropbox\Sign\Model\TeamGetInfoResponse'; $request = $this->teamInfoRequest($team_id, $contentType); @@ -1577,9 +1640,9 @@ public function teamInfoAsyncWithHttpInfo(string $team_id = null, string $conten ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1588,7 +1651,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1602,7 +1665,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1611,15 +1674,18 @@ function ($exception) { /** * Create request for operation 'teamInfo' * - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::teamInfo. This method will eventually become unavailable */ - public function teamInfoRequest(string $team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) + public function teamInfoRequest($team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) { + + + $resourcePath = '/team/info'; $formParams = []; $queryParams = []; @@ -1637,8 +1703,11 @@ public function teamInfoRequest(string $team_id = null, string $contentType = se false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1652,7 +1721,7 @@ public function teamInfoRequest(string $team_id = null, string $contentType = se foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1666,8 +1735,9 @@ public function teamInfoRequest(string $team_id = null, string $contentType = se } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1710,13 +1780,13 @@ public function teamInfoRequest(string $team_id = null, string $contentType = se * * List Team Invites * - * @param string $email_address The email address for which to display the team invites. (optional) + * @param string $email_address The email address for which to display the team invites. (optional) * - * @return Model\TeamInvitesResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TeamInvitesResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function teamInvites(string $email_address = null) + public function teamInvites($email_address = null) { list($response) = $this->teamInvitesWithHttpInfo($email_address); return $response; @@ -1727,15 +1797,15 @@ public function teamInvites(string $email_address = null) * * List Team Invites * - * @param string $email_address The email address for which to display the team invites. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation + * @param string $email_address The email address for which to display the team invites. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * - * @return array of Model\TeamInvitesResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TeamInvitesResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::teamInvites. This method will eventually become unavailable */ - public function teamInvitesWithHttpInfo(string $email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) + public function teamInvitesWithHttpInfo($email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) { $request = $this->teamInvitesRequest($email_address, $contentType); @@ -1747,14 +1817,14 @@ public function teamInvitesWithHttpInfo(string $email_address = null, string $co } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1767,14 +1837,14 @@ public function teamInvitesWithHttpInfo(string $email_address = null, string $co sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1783,17 +1853,18 @@ public function teamInvitesWithHttpInfo(string $email_address = null, string $co if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamInvitesResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TeamInvitesResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1810,19 +1881,20 @@ public function teamInvitesWithHttpInfo(string $email_address = null, string $co return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamInvitesResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TeamInvitesResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1839,9 +1911,11 @@ public function teamInvitesWithHttpInfo(string $email_address = null, string $co return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1854,6 +1928,7 @@ public function teamInvitesWithHttpInfo(string $email_address = null, string $co ); $e->setResponseObject($data); break; + } throw $e; } @@ -1864,14 +1939,14 @@ public function teamInvitesWithHttpInfo(string $email_address = null, string $co * * List Team Invites * - * @param string $email_address The email address for which to display the team invites. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation + * @param string $email_address The email address for which to display the team invites. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInvites. This method will eventually become unavailable */ - public function teamInvitesAsync(string $email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) + public function teamInvitesAsync($email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) { return $this->teamInvitesAsyncWithHttpInfo($email_address, $contentType) ->then( @@ -1886,14 +1961,14 @@ function ($response) { * * List Team Invites * - * @param string $email_address The email address for which to display the team invites. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation + * @param string $email_address The email address for which to display the team invites. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInvites. This method will eventually become unavailable */ - public function teamInvitesAsyncWithHttpInfo(string $email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) + public function teamInvitesAsyncWithHttpInfo($email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) { $returnType = '\Dropbox\Sign\Model\TeamInvitesResponse'; $request = $this->teamInvitesRequest($email_address, $contentType); @@ -1903,9 +1978,9 @@ public function teamInvitesAsyncWithHttpInfo(string $email_address = null, strin ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1914,7 +1989,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1928,7 +2003,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1937,15 +2012,18 @@ function ($exception) { /** * Create request for operation 'teamInvites' * - * @param string $email_address The email address for which to display the team invites. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation + * @param string $email_address The email address for which to display the team invites. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::teamInvites. This method will eventually become unavailable */ - public function teamInvitesRequest(string $email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) + public function teamInvitesRequest($email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) { + + + $resourcePath = '/team/invites'; $formParams = []; $queryParams = []; @@ -1963,8 +2041,11 @@ public function teamInvitesRequest(string $email_address = null, string $content false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1978,7 +2059,7 @@ public function teamInvitesRequest(string $email_address = null, string $content foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1992,8 +2073,9 @@ public function teamInvitesRequest(string $email_address = null, string $content } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2036,15 +2118,15 @@ public function teamInvitesRequest(string $email_address = null, string $content * * List Team Members * - * @param string $team_id The id of the team that a member list is being requested from. (required) - * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $team_id The id of the team that a member list is being requested from. (required) + * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * - * @return Model\TeamMembersResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TeamMembersResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function teamMembers(string $team_id, int $page = 1, int $page_size = 20) + public function teamMembers($team_id, $page = 1, $page_size = 20) { list($response) = $this->teamMembersWithHttpInfo($team_id, $page, $page_size); return $response; @@ -2055,17 +2137,17 @@ public function teamMembers(string $team_id, int $page = 1, int $page_size = 20) * * List Team Members * - * @param string $team_id The id of the team that a member list is being requested from. (required) - * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation + * @param string $team_id The id of the team that a member list is being requested from. (required) + * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation * - * @return array of Model\TeamMembersResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TeamMembersResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::teamMembers. This method will eventually become unavailable */ - public function teamMembersWithHttpInfo(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) + public function teamMembersWithHttpInfo($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) { $request = $this->teamMembersRequest($team_id, $page, $page_size, $contentType); @@ -2077,14 +2159,14 @@ public function teamMembersWithHttpInfo(string $team_id, int $page = 1, int $pag } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -2097,14 +2179,14 @@ public function teamMembersWithHttpInfo(string $team_id, int $page = 1, int $pag sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2113,17 +2195,18 @@ public function teamMembersWithHttpInfo(string $team_id, int $page = 1, int $pag if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamMembersResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TeamMembersResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2140,19 +2223,20 @@ public function teamMembersWithHttpInfo(string $team_id, int $page = 1, int $pag return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamMembersResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TeamMembersResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2169,9 +2253,11 @@ public function teamMembersWithHttpInfo(string $team_id, int $page = 1, int $pag return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2184,6 +2270,7 @@ public function teamMembersWithHttpInfo(string $team_id, int $page = 1, int $pag ); $e->setResponseObject($data); break; + } throw $e; } @@ -2194,16 +2281,16 @@ public function teamMembersWithHttpInfo(string $team_id, int $page = 1, int $pag * * List Team Members * - * @param string $team_id The id of the team that a member list is being requested from. (required) - * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation + * @param string $team_id The id of the team that a member list is being requested from. (required) + * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamMembers. This method will eventually become unavailable */ - public function teamMembersAsync(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) + public function teamMembersAsync($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) { return $this->teamMembersAsyncWithHttpInfo($team_id, $page, $page_size, $contentType) ->then( @@ -2218,16 +2305,16 @@ function ($response) { * * List Team Members * - * @param string $team_id The id of the team that a member list is being requested from. (required) - * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation + * @param string $team_id The id of the team that a member list is being requested from. (required) + * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamMembers. This method will eventually become unavailable */ - public function teamMembersAsyncWithHttpInfo(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) + public function teamMembersAsyncWithHttpInfo($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) { $returnType = '\Dropbox\Sign\Model\TeamMembersResponse'; $request = $this->teamMembersRequest($team_id, $page, $page_size, $contentType); @@ -2237,9 +2324,9 @@ public function teamMembersAsyncWithHttpInfo(string $team_id, int $page = 1, int ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2248,7 +2335,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -2262,7 +2349,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2271,30 +2358,33 @@ function ($exception) { /** * Create request for operation 'teamMembers' * - * @param string $team_id The id of the team that a member list is being requested from. (required) - * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation + * @param string $team_id The id of the team that a member list is being requested from. (required) + * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::teamMembers. This method will eventually become unavailable */ - public function teamMembersRequest(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) + public function teamMembersRequest($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) { + // verify the required parameter 'team_id' is set if ($team_id === null || (is_array($team_id) && count($team_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $team_id when calling teamMembers' ); } + if ($page_size !== null && $page_size > 100) { - throw new InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamMembers, must be smaller than or equal to 100.'); + throw new \InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamMembers, must be smaller than or equal to 100.'); } if ($page_size !== null && $page_size < 1) { - throw new InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamMembers, must be bigger than or equal to 1.'); + throw new \InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamMembers, must be bigger than or equal to 1.'); } + $resourcePath = '/team/members/{team_id}'; $formParams = []; @@ -2322,17 +2412,19 @@ public function teamMembersRequest(string $team_id, int $page = 1, int $page_siz false // required ) ?? []); + // path params if ($team_id !== null) { $resourcePath = str_replace( - '{team_id}', + '{' . 'team_id' . '}', ObjectSerializer::toPathValue($team_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -2346,7 +2438,7 @@ public function teamMembersRequest(string $team_id, int $page = 1, int $page_siz foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -2360,8 +2452,9 @@ public function teamMembersRequest(string $team_id, int $page = 1, int $page_siz } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2404,13 +2497,13 @@ public function teamMembersRequest(string $team_id, int $page = 1, int $page_siz * * Remove User from Team * - * @param Model\TeamRemoveMemberRequest $team_remove_member_request team_remove_member_request (required) + * @param \Dropbox\Sign\Model\TeamRemoveMemberRequest $team_remove_member_request team_remove_member_request (required) * - * @return Model\TeamGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function teamRemoveMember(Model\TeamRemoveMemberRequest $team_remove_member_request) + public function teamRemoveMember($team_remove_member_request) { list($response) = $this->teamRemoveMemberWithHttpInfo($team_remove_member_request); return $response; @@ -2421,15 +2514,15 @@ public function teamRemoveMember(Model\TeamRemoveMemberRequest $team_remove_memb * * Remove User from Team * - * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamRemoveMemberRequest $team_remove_member_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * - * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::teamRemoveMember. This method will eventually become unavailable */ - public function teamRemoveMemberWithHttpInfo(Model\TeamRemoveMemberRequest $team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) + public function teamRemoveMemberWithHttpInfo($team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) { $request = $this->teamRemoveMemberRequest($team_remove_member_request, $contentType); @@ -2441,14 +2534,14 @@ public function teamRemoveMemberWithHttpInfo(Model\TeamRemoveMemberRequest $team } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -2461,14 +2554,14 @@ public function teamRemoveMemberWithHttpInfo(Model\TeamRemoveMemberRequest $team sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2477,17 +2570,18 @@ public function teamRemoveMemberWithHttpInfo(Model\TeamRemoveMemberRequest $team if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 201: if ('\Dropbox\Sign\Model\TeamGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TeamGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2504,19 +2598,20 @@ public function teamRemoveMemberWithHttpInfo(Model\TeamRemoveMemberRequest $team return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2533,9 +2628,11 @@ public function teamRemoveMemberWithHttpInfo(Model\TeamRemoveMemberRequest $team return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2548,6 +2645,7 @@ public function teamRemoveMemberWithHttpInfo(Model\TeamRemoveMemberRequest $team ); $e->setResponseObject($data); break; + } throw $e; } @@ -2558,14 +2656,14 @@ public function teamRemoveMemberWithHttpInfo(Model\TeamRemoveMemberRequest $team * * Remove User from Team * - * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamRemoveMemberRequest $team_remove_member_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamRemoveMember. This method will eventually become unavailable */ - public function teamRemoveMemberAsync(Model\TeamRemoveMemberRequest $team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) + public function teamRemoveMemberAsync($team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) { return $this->teamRemoveMemberAsyncWithHttpInfo($team_remove_member_request, $contentType) ->then( @@ -2580,14 +2678,14 @@ function ($response) { * * Remove User from Team * - * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamRemoveMemberRequest $team_remove_member_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamRemoveMember. This method will eventually become unavailable */ - public function teamRemoveMemberAsyncWithHttpInfo(Model\TeamRemoveMemberRequest $team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) + public function teamRemoveMemberAsyncWithHttpInfo($team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) { $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; $request = $this->teamRemoveMemberRequest($team_remove_member_request, $contentType); @@ -2597,9 +2695,9 @@ public function teamRemoveMemberAsyncWithHttpInfo(Model\TeamRemoveMemberRequest ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2608,7 +2706,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -2622,7 +2720,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2631,22 +2729,24 @@ function ($exception) { /** * Create request for operation 'teamRemoveMember' * - * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamRemoveMemberRequest $team_remove_member_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::teamRemoveMember. This method will eventually become unavailable */ - public function teamRemoveMemberRequest(Model\TeamRemoveMemberRequest $team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) + public function teamRemoveMemberRequest($team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) { + // verify the required parameter 'team_remove_member_request' is set if ($team_remove_member_request === null || (is_array($team_remove_member_request) && count($team_remove_member_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $team_remove_member_request when calling teamRemoveMember' ); } + $resourcePath = '/team/remove_member'; $formParams = []; $queryParams = []; @@ -2660,8 +2760,11 @@ public function teamRemoveMemberRequest(Model\TeamRemoveMemberRequest $team_remo $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -2669,7 +2772,7 @@ public function teamRemoveMemberRequest(Model\TeamRemoveMemberRequest $team_remo // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($team_remove_member_request)); } else { $httpBody = $team_remove_member_request; @@ -2682,7 +2785,7 @@ public function teamRemoveMemberRequest(Model\TeamRemoveMemberRequest $team_remo foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -2699,8 +2802,9 @@ public function teamRemoveMemberRequest(Model\TeamRemoveMemberRequest $team_remo $payloadHook('multipart', $multipartContents, $team_remove_member_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2743,15 +2847,15 @@ public function teamRemoveMemberRequest(Model\TeamRemoveMemberRequest $team_remo * * List Sub Teams * - * @param string $team_id The id of the parent Team. (required) - * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $team_id The id of the parent Team. (required) + * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * - * @return Model\TeamSubTeamsResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TeamSubTeamsResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function teamSubTeams(string $team_id, int $page = 1, int $page_size = 20) + public function teamSubTeams($team_id, $page = 1, $page_size = 20) { list($response) = $this->teamSubTeamsWithHttpInfo($team_id, $page, $page_size); return $response; @@ -2762,17 +2866,17 @@ public function teamSubTeams(string $team_id, int $page = 1, int $page_size = 20 * * List Sub Teams * - * @param string $team_id The id of the parent Team. (required) - * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation + * @param string $team_id The id of the parent Team. (required) + * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation * - * @return array of Model\TeamSubTeamsResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TeamSubTeamsResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::teamSubTeams. This method will eventually become unavailable */ - public function teamSubTeamsWithHttpInfo(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) + public function teamSubTeamsWithHttpInfo($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) { $request = $this->teamSubTeamsRequest($team_id, $page, $page_size, $contentType); @@ -2784,14 +2888,14 @@ public function teamSubTeamsWithHttpInfo(string $team_id, int $page = 1, int $pa } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -2804,14 +2908,14 @@ public function teamSubTeamsWithHttpInfo(string $team_id, int $page = 1, int $pa sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2820,17 +2924,18 @@ public function teamSubTeamsWithHttpInfo(string $team_id, int $page = 1, int $pa if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamSubTeamsResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TeamSubTeamsResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2847,19 +2952,20 @@ public function teamSubTeamsWithHttpInfo(string $team_id, int $page = 1, int $pa return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamSubTeamsResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TeamSubTeamsResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2876,9 +2982,11 @@ public function teamSubTeamsWithHttpInfo(string $team_id, int $page = 1, int $pa return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2891,6 +2999,7 @@ public function teamSubTeamsWithHttpInfo(string $team_id, int $page = 1, int $pa ); $e->setResponseObject($data); break; + } throw $e; } @@ -2901,16 +3010,16 @@ public function teamSubTeamsWithHttpInfo(string $team_id, int $page = 1, int $pa * * List Sub Teams * - * @param string $team_id The id of the parent Team. (required) - * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation + * @param string $team_id The id of the parent Team. (required) + * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamSubTeams. This method will eventually become unavailable */ - public function teamSubTeamsAsync(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) + public function teamSubTeamsAsync($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) { return $this->teamSubTeamsAsyncWithHttpInfo($team_id, $page, $page_size, $contentType) ->then( @@ -2925,16 +3034,16 @@ function ($response) { * * List Sub Teams * - * @param string $team_id The id of the parent Team. (required) - * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation + * @param string $team_id The id of the parent Team. (required) + * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamSubTeams. This method will eventually become unavailable */ - public function teamSubTeamsAsyncWithHttpInfo(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) + public function teamSubTeamsAsyncWithHttpInfo($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) { $returnType = '\Dropbox\Sign\Model\TeamSubTeamsResponse'; $request = $this->teamSubTeamsRequest($team_id, $page, $page_size, $contentType); @@ -2944,9 +3053,9 @@ public function teamSubTeamsAsyncWithHttpInfo(string $team_id, int $page = 1, in ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2955,7 +3064,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -2969,7 +3078,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2978,30 +3087,33 @@ function ($exception) { /** * Create request for operation 'teamSubTeams' * - * @param string $team_id The id of the parent Team. (required) - * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation + * @param string $team_id The id of the parent Team. (required) + * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::teamSubTeams. This method will eventually become unavailable */ - public function teamSubTeamsRequest(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) + public function teamSubTeamsRequest($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) { + // verify the required parameter 'team_id' is set if ($team_id === null || (is_array($team_id) && count($team_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $team_id when calling teamSubTeams' ); } + if ($page_size !== null && $page_size > 100) { - throw new InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamSubTeams, must be smaller than or equal to 100.'); + throw new \InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamSubTeams, must be smaller than or equal to 100.'); } if ($page_size !== null && $page_size < 1) { - throw new InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamSubTeams, must be bigger than or equal to 1.'); + throw new \InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamSubTeams, must be bigger than or equal to 1.'); } + $resourcePath = '/team/sub_teams/{team_id}'; $formParams = []; @@ -3029,17 +3141,19 @@ public function teamSubTeamsRequest(string $team_id, int $page = 1, int $page_si false // required ) ?? []); + // path params if ($team_id !== null) { $resourcePath = str_replace( - '{team_id}', + '{' . 'team_id' . '}', ObjectSerializer::toPathValue($team_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -3053,7 +3167,7 @@ public function teamSubTeamsRequest(string $team_id, int $page = 1, int $page_si foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -3067,8 +3181,9 @@ public function teamSubTeamsRequest(string $team_id, int $page = 1, int $page_si } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3111,13 +3226,13 @@ public function teamSubTeamsRequest(string $team_id, int $page = 1, int $page_si * * Update Team * - * @param Model\TeamUpdateRequest $team_update_request team_update_request (required) + * @param \Dropbox\Sign\Model\TeamUpdateRequest $team_update_request team_update_request (required) * - * @return Model\TeamGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function teamUpdate(Model\TeamUpdateRequest $team_update_request) + public function teamUpdate($team_update_request) { list($response) = $this->teamUpdateWithHttpInfo($team_update_request); return $response; @@ -3128,15 +3243,15 @@ public function teamUpdate(Model\TeamUpdateRequest $team_update_request) * * Update Team * - * @param Model\TeamUpdateRequest $team_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamUpdateRequest $team_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * - * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::teamUpdate. This method will eventually become unavailable */ - public function teamUpdateWithHttpInfo(Model\TeamUpdateRequest $team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) + public function teamUpdateWithHttpInfo($team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) { $request = $this->teamUpdateRequest($team_update_request, $contentType); @@ -3148,14 +3263,14 @@ public function teamUpdateWithHttpInfo(Model\TeamUpdateRequest $team_update_requ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -3168,14 +3283,14 @@ public function teamUpdateWithHttpInfo(Model\TeamUpdateRequest $team_update_requ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3184,17 +3299,18 @@ public function teamUpdateWithHttpInfo(Model\TeamUpdateRequest $team_update_requ if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TeamGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3211,19 +3327,20 @@ public function teamUpdateWithHttpInfo(Model\TeamUpdateRequest $team_update_requ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3240,9 +3357,11 @@ public function teamUpdateWithHttpInfo(Model\TeamUpdateRequest $team_update_requ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3255,6 +3374,7 @@ public function teamUpdateWithHttpInfo(Model\TeamUpdateRequest $team_update_requ ); $e->setResponseObject($data); break; + } throw $e; } @@ -3265,14 +3385,14 @@ public function teamUpdateWithHttpInfo(Model\TeamUpdateRequest $team_update_requ * * Update Team * - * @param Model\TeamUpdateRequest $team_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamUpdateRequest $team_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamUpdate. This method will eventually become unavailable */ - public function teamUpdateAsync(Model\TeamUpdateRequest $team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) + public function teamUpdateAsync($team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) { return $this->teamUpdateAsyncWithHttpInfo($team_update_request, $contentType) ->then( @@ -3287,14 +3407,14 @@ function ($response) { * * Update Team * - * @param Model\TeamUpdateRequest $team_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamUpdateRequest $team_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::teamUpdate. This method will eventually become unavailable */ - public function teamUpdateAsyncWithHttpInfo(Model\TeamUpdateRequest $team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) + public function teamUpdateAsyncWithHttpInfo($team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) { $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; $request = $this->teamUpdateRequest($team_update_request, $contentType); @@ -3304,9 +3424,9 @@ public function teamUpdateAsyncWithHttpInfo(Model\TeamUpdateRequest $team_update ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3315,7 +3435,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -3329,7 +3449,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -3338,22 +3458,24 @@ function ($exception) { /** * Create request for operation 'teamUpdate' * - * @param Model\TeamUpdateRequest $team_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TeamUpdateRequest $team_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::teamUpdate. This method will eventually become unavailable */ - public function teamUpdateRequest(Model\TeamUpdateRequest $team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) + public function teamUpdateRequest($team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) { + // verify the required parameter 'team_update_request' is set if ($team_update_request === null || (is_array($team_update_request) && count($team_update_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $team_update_request when calling teamUpdate' ); } + $resourcePath = '/team'; $formParams = []; $queryParams = []; @@ -3367,8 +3489,11 @@ public function teamUpdateRequest(Model\TeamUpdateRequest $team_update_request, $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -3376,7 +3501,7 @@ public function teamUpdateRequest(Model\TeamUpdateRequest $team_update_request, // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($team_update_request)); } else { $httpBody = $team_update_request; @@ -3389,7 +3514,7 @@ public function teamUpdateRequest(Model\TeamUpdateRequest $team_update_request, foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -3406,8 +3531,9 @@ public function teamUpdateRequest(Model\TeamUpdateRequest $team_update_request, $payloadHook('multipart', $multipartContents, $team_update_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3448,8 +3574,8 @@ public function teamUpdateRequest(Model\TeamUpdateRequest $team_update_request, /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -3457,7 +3583,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -3473,8 +3599,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -3484,9 +3610,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -3505,8 +3631,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/TemplateApi.php b/sdks/php/src/Api/TemplateApi.php index 091dc84d6..5926911eb 100644 --- a/sdks/php/src/Api/TemplateApi.php +++ b/sdks/php/src/Api/TemplateApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,35 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; -use SplFileObject; /** * TemplateApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class TemplateApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'templateAddUser' => [ 'application/json', @@ -110,13 +116,16 @@ class TemplateApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -130,7 +139,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -167,14 +176,14 @@ public function getResponse() * * Add User to Template * - * @param string $template_id The id of the Template to give the Account access to. (required) - * @param Model\TemplateAddUserRequest $template_add_user_request template_add_user_request (required) + * @param string $template_id The id of the Template to give the Account access to. (required) + * @param \Dropbox\Sign\Model\TemplateAddUserRequest $template_add_user_request template_add_user_request (required) * - * @return Model\TemplateGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function templateAddUser(string $template_id, Model\TemplateAddUserRequest $template_add_user_request) + public function templateAddUser($template_id, $template_add_user_request) { list($response) = $this->templateAddUserWithHttpInfo($template_id, $template_add_user_request); return $response; @@ -185,16 +194,16 @@ public function templateAddUser(string $template_id, Model\TemplateAddUserReques * * Add User to Template * - * @param string $template_id The id of the Template to give the Account access to. (required) - * @param Model\TemplateAddUserRequest $template_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to give the Account access to. (required) + * @param \Dropbox\Sign\Model\TemplateAddUserRequest $template_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation * - * @return array of Model\TemplateGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::templateAddUser. This method will eventually become unavailable */ - public function templateAddUserWithHttpInfo(string $template_id, Model\TemplateAddUserRequest $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) + public function templateAddUserWithHttpInfo($template_id, $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) { $request = $this->templateAddUserRequest($template_id, $template_add_user_request, $contentType); @@ -206,14 +215,14 @@ public function templateAddUserWithHttpInfo(string $template_id, Model\TemplateA } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -226,14 +235,14 @@ public function templateAddUserWithHttpInfo(string $template_id, Model\TemplateA sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -242,17 +251,18 @@ public function templateAddUserWithHttpInfo(string $template_id, Model\TemplateA if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TemplateGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -269,19 +279,20 @@ public function templateAddUserWithHttpInfo(string $template_id, Model\TemplateA return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -298,9 +309,11 @@ public function templateAddUserWithHttpInfo(string $template_id, Model\TemplateA return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -313,6 +326,7 @@ public function templateAddUserWithHttpInfo(string $template_id, Model\TemplateA ); $e->setResponseObject($data); break; + } throw $e; } @@ -323,15 +337,15 @@ public function templateAddUserWithHttpInfo(string $template_id, Model\TemplateA * * Add User to Template * - * @param string $template_id The id of the Template to give the Account access to. (required) - * @param Model\TemplateAddUserRequest $template_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to give the Account access to. (required) + * @param \Dropbox\Sign\Model\TemplateAddUserRequest $template_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateAddUser. This method will eventually become unavailable */ - public function templateAddUserAsync(string $template_id, Model\TemplateAddUserRequest $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) + public function templateAddUserAsync($template_id, $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) { return $this->templateAddUserAsyncWithHttpInfo($template_id, $template_add_user_request, $contentType) ->then( @@ -346,15 +360,15 @@ function ($response) { * * Add User to Template * - * @param string $template_id The id of the Template to give the Account access to. (required) - * @param Model\TemplateAddUserRequest $template_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to give the Account access to. (required) + * @param \Dropbox\Sign\Model\TemplateAddUserRequest $template_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateAddUser. This method will eventually become unavailable */ - public function templateAddUserAsyncWithHttpInfo(string $template_id, Model\TemplateAddUserRequest $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) + public function templateAddUserAsyncWithHttpInfo($template_id, $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; $request = $this->templateAddUserRequest($template_id, $template_add_user_request, $contentType); @@ -364,9 +378,9 @@ public function templateAddUserAsyncWithHttpInfo(string $template_id, Model\Temp ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -375,7 +389,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -389,7 +403,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -398,30 +412,32 @@ function ($exception) { /** * Create request for operation 'templateAddUser' * - * @param string $template_id The id of the Template to give the Account access to. (required) - * @param Model\TemplateAddUserRequest $template_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to give the Account access to. (required) + * @param \Dropbox\Sign\Model\TemplateAddUserRequest $template_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateAddUser. This method will eventually become unavailable */ - public function templateAddUserRequest(string $template_id, Model\TemplateAddUserRequest $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) + public function templateAddUserRequest($template_id, $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) { + // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_id when calling templateAddUser' ); } // verify the required parameter 'template_add_user_request' is set if ($template_add_user_request === null || (is_array($template_add_user_request) && count($template_add_user_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_add_user_request when calling templateAddUser' ); } + $resourcePath = '/template/add_user/{template_id}'; $formParams = []; $queryParams = []; @@ -435,17 +451,19 @@ public function templateAddUserRequest(string $template_id, Model\TemplateAddUse $multipart = !empty($formParams); + // path params if ($template_id !== null) { $resourcePath = str_replace( - '{template_id}', + '{' . 'template_id' . '}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -453,7 +471,7 @@ public function templateAddUserRequest(string $template_id, Model\TemplateAddUse // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_add_user_request)); } else { $httpBody = $template_add_user_request; @@ -466,7 +484,7 @@ public function templateAddUserRequest(string $template_id, Model\TemplateAddUse foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -483,8 +501,9 @@ public function templateAddUserRequest(string $template_id, Model\TemplateAddUse $payloadHook('multipart', $multipartContents, $template_add_user_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -527,13 +546,13 @@ public function templateAddUserRequest(string $template_id, Model\TemplateAddUse * * Create Template * - * @param Model\TemplateCreateRequest $template_create_request template_create_request (required) + * @param \Dropbox\Sign\Model\TemplateCreateRequest $template_create_request template_create_request (required) * - * @return Model\TemplateCreateResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TemplateCreateResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function templateCreate(Model\TemplateCreateRequest $template_create_request) + public function templateCreate($template_create_request) { list($response) = $this->templateCreateWithHttpInfo($template_create_request); return $response; @@ -544,15 +563,15 @@ public function templateCreate(Model\TemplateCreateRequest $template_create_requ * * Create Template * - * @param Model\TemplateCreateRequest $template_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TemplateCreateRequest $template_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * - * @return array of Model\TemplateCreateResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TemplateCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::templateCreate. This method will eventually become unavailable */ - public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) + public function templateCreateWithHttpInfo($template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) { $request = $this->templateCreateRequest($template_create_request, $contentType); @@ -564,14 +583,14 @@ public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -584,14 +603,14 @@ public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -600,17 +619,18 @@ public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TemplateCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -627,19 +647,20 @@ public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateCreateResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TemplateCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -656,9 +677,11 @@ public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -671,6 +694,7 @@ public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template ); $e->setResponseObject($data); break; + } throw $e; } @@ -681,14 +705,14 @@ public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template * * Create Template * - * @param Model\TemplateCreateRequest $template_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TemplateCreateRequest $template_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreate. This method will eventually become unavailable */ - public function templateCreateAsync(Model\TemplateCreateRequest $template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) + public function templateCreateAsync($template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) { return $this->templateCreateAsyncWithHttpInfo($template_create_request, $contentType) ->then( @@ -703,14 +727,14 @@ function ($response) { * * Create Template * - * @param Model\TemplateCreateRequest $template_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TemplateCreateRequest $template_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreate. This method will eventually become unavailable */ - public function templateCreateAsyncWithHttpInfo(Model\TemplateCreateRequest $template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) + public function templateCreateAsyncWithHttpInfo($template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateCreateResponse'; $request = $this->templateCreateRequest($template_create_request, $contentType); @@ -720,9 +744,9 @@ public function templateCreateAsyncWithHttpInfo(Model\TemplateCreateRequest $tem ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -731,7 +755,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -745,7 +769,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -754,22 +778,24 @@ function ($exception) { /** * Create request for operation 'templateCreate' * - * @param Model\TemplateCreateRequest $template_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TemplateCreateRequest $template_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateCreate. This method will eventually become unavailable */ - public function templateCreateRequest(Model\TemplateCreateRequest $template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) + public function templateCreateRequest($template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) { + // verify the required parameter 'template_create_request' is set if ($template_create_request === null || (is_array($template_create_request) && count($template_create_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_create_request when calling templateCreate' ); } + $resourcePath = '/template/create'; $formParams = []; $queryParams = []; @@ -783,8 +809,11 @@ public function templateCreateRequest(Model\TemplateCreateRequest $template_crea $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -792,7 +821,7 @@ public function templateCreateRequest(Model\TemplateCreateRequest $template_crea // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_create_request)); } else { $httpBody = $template_create_request; @@ -805,7 +834,7 @@ public function templateCreateRequest(Model\TemplateCreateRequest $template_crea foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -822,8 +851,9 @@ public function templateCreateRequest(Model\TemplateCreateRequest $template_crea $payloadHook('multipart', $multipartContents, $template_create_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -866,13 +896,13 @@ public function templateCreateRequest(Model\TemplateCreateRequest $template_crea * * Create Embedded Template Draft * - * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request template_create_embedded_draft_request (required) + * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request template_create_embedded_draft_request (required) * - * @return Model\TemplateCreateEmbeddedDraftResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function templateCreateEmbeddedDraft(Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request) + public function templateCreateEmbeddedDraft($template_create_embedded_draft_request) { list($response) = $this->templateCreateEmbeddedDraftWithHttpInfo($template_create_embedded_draft_request); return $response; @@ -883,15 +913,15 @@ public function templateCreateEmbeddedDraft(Model\TemplateCreateEmbeddedDraftReq * * Create Embedded Template Draft * - * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * - * @return array of Model\TemplateCreateEmbeddedDraftResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::templateCreateEmbeddedDraft. This method will eventually become unavailable */ - public function templateCreateEmbeddedDraftWithHttpInfo(Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) + public function templateCreateEmbeddedDraftWithHttpInfo($template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) { $request = $this->templateCreateEmbeddedDraftRequest($template_create_embedded_draft_request, $contentType); @@ -903,14 +933,14 @@ public function templateCreateEmbeddedDraftWithHttpInfo(Model\TemplateCreateEmbe } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -923,14 +953,14 @@ public function templateCreateEmbeddedDraftWithHttpInfo(Model\TemplateCreateEmbe sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -939,17 +969,18 @@ public function templateCreateEmbeddedDraftWithHttpInfo(Model\TemplateCreateEmbe if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -966,19 +997,20 @@ public function templateCreateEmbeddedDraftWithHttpInfo(Model\TemplateCreateEmbe return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -995,9 +1027,11 @@ public function templateCreateEmbeddedDraftWithHttpInfo(Model\TemplateCreateEmbe return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1010,6 +1044,7 @@ public function templateCreateEmbeddedDraftWithHttpInfo(Model\TemplateCreateEmbe ); $e->setResponseObject($data); break; + } throw $e; } @@ -1020,14 +1055,14 @@ public function templateCreateEmbeddedDraftWithHttpInfo(Model\TemplateCreateEmbe * * Create Embedded Template Draft * - * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreateEmbeddedDraft. This method will eventually become unavailable */ - public function templateCreateEmbeddedDraftAsync(Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) + public function templateCreateEmbeddedDraftAsync($template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) { return $this->templateCreateEmbeddedDraftAsyncWithHttpInfo($template_create_embedded_draft_request, $contentType) ->then( @@ -1042,14 +1077,14 @@ function ($response) { * * Create Embedded Template Draft * - * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreateEmbeddedDraft. This method will eventually become unavailable */ - public function templateCreateEmbeddedDraftAsyncWithHttpInfo(Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) + public function templateCreateEmbeddedDraftAsyncWithHttpInfo($template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse'; $request = $this->templateCreateEmbeddedDraftRequest($template_create_embedded_draft_request, $contentType); @@ -1059,9 +1094,9 @@ public function templateCreateEmbeddedDraftAsyncWithHttpInfo(Model\TemplateCreat ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1070,7 +1105,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1084,7 +1119,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1093,22 +1128,24 @@ function ($exception) { /** * Create request for operation 'templateCreateEmbeddedDraft' * - * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateCreateEmbeddedDraft. This method will eventually become unavailable */ - public function templateCreateEmbeddedDraftRequest(Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) + public function templateCreateEmbeddedDraftRequest($template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) { + // verify the required parameter 'template_create_embedded_draft_request' is set if ($template_create_embedded_draft_request === null || (is_array($template_create_embedded_draft_request) && count($template_create_embedded_draft_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_create_embedded_draft_request when calling templateCreateEmbeddedDraft' ); } + $resourcePath = '/template/create_embedded_draft'; $formParams = []; $queryParams = []; @@ -1122,8 +1159,11 @@ public function templateCreateEmbeddedDraftRequest(Model\TemplateCreateEmbeddedD $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1131,7 +1171,7 @@ public function templateCreateEmbeddedDraftRequest(Model\TemplateCreateEmbeddedD // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_create_embedded_draft_request)); } else { $httpBody = $template_create_embedded_draft_request; @@ -1144,7 +1184,7 @@ public function templateCreateEmbeddedDraftRequest(Model\TemplateCreateEmbeddedD foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1161,8 +1201,9 @@ public function templateCreateEmbeddedDraftRequest(Model\TemplateCreateEmbeddedD $payloadHook('multipart', $multipartContents, $template_create_embedded_draft_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1205,12 +1246,13 @@ public function templateCreateEmbeddedDraftRequest(Model\TemplateCreateEmbeddedD * * Delete Template * - * @param string $template_id The id of the Template to delete. (required) + * @param string $template_id The id of the Template to delete. (required) * - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return void */ - public function templateDelete(string $template_id) + public function templateDelete($template_id) { $this->templateDeleteWithHttpInfo($template_id); } @@ -1220,15 +1262,15 @@ public function templateDelete(string $template_id) * * Delete Template * - * @param string $template_id The id of the Template to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation + * @param string $template_id The id of the Template to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateDelete. This method will eventually become unavailable */ - public function templateDeleteWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateDelete'][0]) + public function templateDeleteWithHttpInfo($template_id, string $contentType = self::contentTypes['templateDelete'][0]) { $request = $this->templateDeleteRequest($template_id, $contentType); @@ -1240,14 +1282,14 @@ public function templateDeleteWithHttpInfo(string $template_id, string $contentT } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1260,20 +1302,23 @@ public function templateDeleteWithHttpInfo(string $template_id, string $contentT sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { + } throw $e; } @@ -1284,14 +1329,14 @@ public function templateDeleteWithHttpInfo(string $template_id, string $contentT * * Delete Template * - * @param string $template_id The id of the Template to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation + * @param string $template_id The id of the Template to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateDelete. This method will eventually become unavailable */ - public function templateDeleteAsync(string $template_id, string $contentType = self::contentTypes['templateDelete'][0]) + public function templateDeleteAsync($template_id, string $contentType = self::contentTypes['templateDelete'][0]) { return $this->templateDeleteAsyncWithHttpInfo($template_id, $contentType) ->then( @@ -1306,14 +1351,14 @@ function ($response) { * * Delete Template * - * @param string $template_id The id of the Template to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation + * @param string $template_id The id of the Template to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateDelete. This method will eventually become unavailable */ - public function templateDeleteAsyncWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateDelete'][0]) + public function templateDeleteAsyncWithHttpInfo($template_id, string $contentType = self::contentTypes['templateDelete'][0]) { $returnType = ''; $request = $this->templateDeleteRequest($template_id, $contentType); @@ -1321,7 +1366,7 @@ public function templateDeleteAsyncWithHttpInfo(string $template_id, string $con return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) { + function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -1335,7 +1380,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1344,22 +1389,24 @@ function ($exception) { /** * Create request for operation 'templateDelete' * - * @param string $template_id The id of the Template to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation + * @param string $template_id The id of the Template to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateDelete. This method will eventually become unavailable */ - public function templateDeleteRequest(string $template_id, string $contentType = self::contentTypes['templateDelete'][0]) + public function templateDeleteRequest($template_id, string $contentType = self::contentTypes['templateDelete'][0]) { + // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_id when calling templateDelete' ); } + $resourcePath = '/template/delete/{template_id}'; $formParams = []; $queryParams = []; @@ -1367,17 +1414,20 @@ public function templateDeleteRequest(string $template_id, string $contentType = $httpBody = ''; $multipart = false; + + // path params if ($template_id !== null) { $resourcePath = str_replace( - '{template_id}', + '{' . 'template_id' . '}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1391,7 +1441,7 @@ public function templateDeleteRequest(string $template_id, string $contentType = foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1405,8 +1455,9 @@ public function templateDeleteRequest(string $template_id, string $contentType = } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1449,14 +1500,14 @@ public function templateDeleteRequest(string $template_id, string $contentType = * * Get Template Files * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) * - * @return SplFileObject - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \SplFileObject|\Dropbox\Sign\Model\ErrorResponse */ - public function templateFiles(string $template_id, string $file_type = null) + public function templateFiles($template_id, $file_type = null) { list($response) = $this->templateFilesWithHttpInfo($template_id, $file_type); return $response; @@ -1467,16 +1518,16 @@ public function templateFiles(string $template_id, string $file_type = null) * * Get Template Files * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation * + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException * @return array of \SplFileObject|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFiles. This method will eventually become unavailable */ - public function templateFilesWithHttpInfo(string $template_id, string $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) + public function templateFilesWithHttpInfo($template_id, $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) { $request = $this->templateFilesRequest($template_id, $file_type, $contentType); @@ -1488,14 +1539,14 @@ public function templateFilesWithHttpInfo(string $template_id, string $file_type } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1508,14 +1559,14 @@ public function templateFilesWithHttpInfo(string $template_id, string $file_type sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1524,17 +1575,18 @@ public function templateFilesWithHttpInfo(string $template_id, string $file_type if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\SplFileObject' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\SplFileObject' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1551,19 +1603,20 @@ public function templateFilesWithHttpInfo(string $template_id, string $file_type return [ ObjectSerializer::deserialize($content, '\SplFileObject', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\SplFileObject'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1580,9 +1633,11 @@ public function templateFilesWithHttpInfo(string $template_id, string $file_type return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1595,6 +1650,7 @@ public function templateFilesWithHttpInfo(string $template_id, string $file_type ); $e->setResponseObject($data); break; + } throw $e; } @@ -1605,15 +1661,15 @@ public function templateFilesWithHttpInfo(string $template_id, string $file_type * * Get Template Files * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFiles. This method will eventually become unavailable */ - public function templateFilesAsync(string $template_id, string $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) + public function templateFilesAsync($template_id, $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) { return $this->templateFilesAsyncWithHttpInfo($template_id, $file_type, $contentType) ->then( @@ -1628,15 +1684,15 @@ function ($response) { * * Get Template Files * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFiles. This method will eventually become unavailable */ - public function templateFilesAsyncWithHttpInfo(string $template_id, string $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) + public function templateFilesAsyncWithHttpInfo($template_id, $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) { $returnType = '\SplFileObject'; $request = $this->templateFilesRequest($template_id, $file_type, $contentType); @@ -1646,9 +1702,9 @@ public function templateFilesAsyncWithHttpInfo(string $template_id, string $file ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1657,7 +1713,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1671,7 +1727,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1680,23 +1736,26 @@ function ($exception) { /** * Create request for operation 'templateFiles' * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateFiles. This method will eventually become unavailable */ - public function templateFilesRequest(string $template_id, string $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) + public function templateFilesRequest($template_id, $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) { + // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_id when calling templateFiles' ); } + + $resourcePath = '/template/files/{template_id}'; $formParams = []; $queryParams = []; @@ -1714,17 +1773,19 @@ public function templateFilesRequest(string $template_id, string $file_type = nu false // required ) ?? []); + // path params if ($template_id !== null) { $resourcePath = str_replace( - '{template_id}', + '{' . 'template_id' . '}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/zip', 'application/json'], + $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/zip', 'application/json', ], $contentType, $multipart ); @@ -1738,7 +1799,7 @@ public function templateFilesRequest(string $template_id, string $file_type = nu foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1752,8 +1813,9 @@ public function templateFilesRequest(string $template_id, string $file_type = nu } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1796,13 +1858,13 @@ public function templateFilesRequest(string $template_id, string $file_type = nu * * Get Template Files as Data Uri * - * @param string $template_id The id of the template files to retrieve. (required) + * @param string $template_id The id of the template files to retrieve. (required) * - * @return Model\FileResponseDataUri - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FileResponseDataUri|\Dropbox\Sign\Model\ErrorResponse */ - public function templateFilesAsDataUri(string $template_id) + public function templateFilesAsDataUri($template_id) { list($response) = $this->templateFilesAsDataUriWithHttpInfo($template_id); return $response; @@ -1813,15 +1875,15 @@ public function templateFilesAsDataUri(string $template_id) * * Get Template Files as Data Uri * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * - * @return array of Model\FileResponseDataUri, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FileResponseDataUri|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::templateFilesAsDataUri. This method will eventually become unavailable */ - public function templateFilesAsDataUriWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) + public function templateFilesAsDataUriWithHttpInfo($template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) { $request = $this->templateFilesAsDataUriRequest($template_id, $contentType); @@ -1833,14 +1895,14 @@ public function templateFilesAsDataUriWithHttpInfo(string $template_id, string $ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1853,14 +1915,14 @@ public function templateFilesAsDataUriWithHttpInfo(string $template_id, string $ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1869,17 +1931,18 @@ public function templateFilesAsDataUriWithHttpInfo(string $template_id, string $ if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FileResponseDataUri' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FileResponseDataUri' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1896,19 +1959,20 @@ public function templateFilesAsDataUriWithHttpInfo(string $template_id, string $ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FileResponseDataUri', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FileResponseDataUri'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1925,9 +1989,11 @@ public function templateFilesAsDataUriWithHttpInfo(string $template_id, string $ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1940,6 +2006,7 @@ public function templateFilesAsDataUriWithHttpInfo(string $template_id, string $ ); $e->setResponseObject($data); break; + } throw $e; } @@ -1950,14 +2017,14 @@ public function templateFilesAsDataUriWithHttpInfo(string $template_id, string $ * * Get Template Files as Data Uri * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsDataUri. This method will eventually become unavailable */ - public function templateFilesAsDataUriAsync(string $template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) + public function templateFilesAsDataUriAsync($template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) { return $this->templateFilesAsDataUriAsyncWithHttpInfo($template_id, $contentType) ->then( @@ -1972,14 +2039,14 @@ function ($response) { * * Get Template Files as Data Uri * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsDataUri. This method will eventually become unavailable */ - public function templateFilesAsDataUriAsyncWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) + public function templateFilesAsDataUriAsyncWithHttpInfo($template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) { $returnType = '\Dropbox\Sign\Model\FileResponseDataUri'; $request = $this->templateFilesAsDataUriRequest($template_id, $contentType); @@ -1989,9 +2056,9 @@ public function templateFilesAsDataUriAsyncWithHttpInfo(string $template_id, str ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2000,7 +2067,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -2014,7 +2081,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2023,22 +2090,24 @@ function ($exception) { /** * Create request for operation 'templateFilesAsDataUri' * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateFilesAsDataUri. This method will eventually become unavailable */ - public function templateFilesAsDataUriRequest(string $template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) + public function templateFilesAsDataUriRequest($template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) { + // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_id when calling templateFilesAsDataUri' ); } + $resourcePath = '/template/files_as_data_uri/{template_id}'; $formParams = []; $queryParams = []; @@ -2046,17 +2115,20 @@ public function templateFilesAsDataUriRequest(string $template_id, string $conte $httpBody = ''; $multipart = false; + + // path params if ($template_id !== null) { $resourcePath = str_replace( - '{template_id}', + '{' . 'template_id' . '}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -2070,7 +2142,7 @@ public function templateFilesAsDataUriRequest(string $template_id, string $conte foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -2084,8 +2156,9 @@ public function templateFilesAsDataUriRequest(string $template_id, string $conte } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2128,14 +2201,14 @@ public function templateFilesAsDataUriRequest(string $template_id, string $conte * * Get Template Files as File Url * - * @param string $template_id The id of the template files to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $template_id The id of the template files to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * - * @return Model\FileResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\FileResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function templateFilesAsFileUrl(string $template_id, int $force_download = 1) + public function templateFilesAsFileUrl($template_id, $force_download = 1) { list($response) = $this->templateFilesAsFileUrlWithHttpInfo($template_id, $force_download); return $response; @@ -2146,16 +2219,16 @@ public function templateFilesAsFileUrl(string $template_id, int $force_download * * Get Template Files as File Url * - * @param string $template_id The id of the template files to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation * - * @return array of Model\FileResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\FileResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::templateFilesAsFileUrl. This method will eventually become unavailable */ - public function templateFilesAsFileUrlWithHttpInfo(string $template_id, int $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) + public function templateFilesAsFileUrlWithHttpInfo($template_id, $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) { $request = $this->templateFilesAsFileUrlRequest($template_id, $force_download, $contentType); @@ -2167,14 +2240,14 @@ public function templateFilesAsFileUrlWithHttpInfo(string $template_id, int $for } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -2187,14 +2260,14 @@ public function templateFilesAsFileUrlWithHttpInfo(string $template_id, int $for sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2203,17 +2276,18 @@ public function templateFilesAsFileUrlWithHttpInfo(string $template_id, int $for if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\FileResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\FileResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2230,19 +2304,20 @@ public function templateFilesAsFileUrlWithHttpInfo(string $template_id, int $for return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FileResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\FileResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2259,9 +2334,11 @@ public function templateFilesAsFileUrlWithHttpInfo(string $template_id, int $for return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2274,6 +2351,7 @@ public function templateFilesAsFileUrlWithHttpInfo(string $template_id, int $for ); $e->setResponseObject($data); break; + } throw $e; } @@ -2284,15 +2362,15 @@ public function templateFilesAsFileUrlWithHttpInfo(string $template_id, int $for * * Get Template Files as File Url * - * @param string $template_id The id of the template files to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsFileUrl. This method will eventually become unavailable */ - public function templateFilesAsFileUrlAsync(string $template_id, int $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) + public function templateFilesAsFileUrlAsync($template_id, $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) { return $this->templateFilesAsFileUrlAsyncWithHttpInfo($template_id, $force_download, $contentType) ->then( @@ -2307,15 +2385,15 @@ function ($response) { * * Get Template Files as File Url * - * @param string $template_id The id of the template files to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsFileUrl. This method will eventually become unavailable */ - public function templateFilesAsFileUrlAsyncWithHttpInfo(string $template_id, int $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) + public function templateFilesAsFileUrlAsyncWithHttpInfo($template_id, $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) { $returnType = '\Dropbox\Sign\Model\FileResponse'; $request = $this->templateFilesAsFileUrlRequest($template_id, $force_download, $contentType); @@ -2325,9 +2403,9 @@ public function templateFilesAsFileUrlAsyncWithHttpInfo(string $template_id, int ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2336,7 +2414,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -2350,7 +2428,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2359,23 +2437,26 @@ function ($exception) { /** * Create request for operation 'templateFilesAsFileUrl' * - * @param string $template_id The id of the template files to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateFilesAsFileUrl. This method will eventually become unavailable */ - public function templateFilesAsFileUrlRequest(string $template_id, int $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) + public function templateFilesAsFileUrlRequest($template_id, $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) { + // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_id when calling templateFilesAsFileUrl' ); } + + $resourcePath = '/template/files_as_file_url/{template_id}'; $formParams = []; $queryParams = []; @@ -2393,17 +2474,19 @@ public function templateFilesAsFileUrlRequest(string $template_id, int $force_do false // required ) ?? []); + // path params if ($template_id !== null) { $resourcePath = str_replace( - '{template_id}', + '{' . 'template_id' . '}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -2417,7 +2500,7 @@ public function templateFilesAsFileUrlRequest(string $template_id, int $force_do foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -2431,8 +2514,9 @@ public function templateFilesAsFileUrlRequest(string $template_id, int $force_do } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2475,13 +2559,13 @@ public function templateFilesAsFileUrlRequest(string $template_id, int $force_do * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) + * @param string $template_id The id of the Template to retrieve. (required) * - * @return Model\TemplateGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function templateGet(string $template_id) + public function templateGet($template_id) { list($response) = $this->templateGetWithHttpInfo($template_id); return $response; @@ -2492,15 +2576,15 @@ public function templateGet(string $template_id) * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * - * @return array of Model\TemplateGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetWithHttpInfo($template_id, string $contentType = self::contentTypes['templateGet'][0]) { $request = $this->templateGetRequest($template_id, $contentType); @@ -2512,14 +2596,14 @@ public function templateGetWithHttpInfo(string $template_id, string $contentType } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -2532,14 +2616,14 @@ public function templateGetWithHttpInfo(string $template_id, string $contentType sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2548,17 +2632,18 @@ public function templateGetWithHttpInfo(string $template_id, string $contentType if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TemplateGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2575,19 +2660,20 @@ public function templateGetWithHttpInfo(string $template_id, string $contentType return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2604,9 +2690,11 @@ public function templateGetWithHttpInfo(string $template_id, string $contentType return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2619,6 +2707,7 @@ public function templateGetWithHttpInfo(string $template_id, string $contentType ); $e->setResponseObject($data); break; + } throw $e; } @@ -2629,14 +2718,14 @@ public function templateGetWithHttpInfo(string $template_id, string $contentType * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetAsync(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetAsync($template_id, string $contentType = self::contentTypes['templateGet'][0]) { return $this->templateGetAsyncWithHttpInfo($template_id, $contentType) ->then( @@ -2651,14 +2740,14 @@ function ($response) { * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetAsyncWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetAsyncWithHttpInfo($template_id, string $contentType = self::contentTypes['templateGet'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; $request = $this->templateGetRequest($template_id, $contentType); @@ -2668,9 +2757,9 @@ public function templateGetAsyncWithHttpInfo(string $template_id, string $conten ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2679,7 +2768,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -2693,7 +2782,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -2702,22 +2791,24 @@ function ($exception) { /** * Create request for operation 'templateGet' * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetRequest(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetRequest($template_id, string $contentType = self::contentTypes['templateGet'][0]) { + // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_id when calling templateGet' ); } + $resourcePath = '/template/{template_id}'; $formParams = []; $queryParams = []; @@ -2725,17 +2816,20 @@ public function templateGetRequest(string $template_id, string $contentType = se $httpBody = ''; $multipart = false; + + // path params if ($template_id !== null) { $resourcePath = str_replace( - '{template_id}', + '{' . 'template_id' . '}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -2749,7 +2843,7 @@ public function templateGetRequest(string $template_id, string $contentType = se foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -2763,8 +2857,9 @@ public function templateGetRequest(string $template_id, string $contentType = se } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2807,16 +2902,16 @@ public function templateGetRequest(string $template_id, string $contentType = se * * List Templates * - * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) + * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) * - * @return Model\TemplateListResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TemplateListResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function templateList(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null) + public function templateList($account_id = null, $page = 1, $page_size = 20, $query = null) { list($response) = $this->templateListWithHttpInfo($account_id, $page, $page_size, $query); return $response; @@ -2827,18 +2922,18 @@ public function templateList(string $account_id = null, int $page = 1, int $page * * List Templates * - * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation + * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation * - * @return array of Model\TemplateListResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TemplateListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::templateList. This method will eventually become unavailable */ - public function templateListWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['templateList'][0]) + public function templateListWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['templateList'][0]) { $request = $this->templateListRequest($account_id, $page, $page_size, $query, $contentType); @@ -2850,14 +2945,14 @@ public function templateListWithHttpInfo(string $account_id = null, int $page = } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -2870,14 +2965,14 @@ public function templateListWithHttpInfo(string $account_id = null, int $page = sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2886,17 +2981,18 @@ public function templateListWithHttpInfo(string $account_id = null, int $page = if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateListResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TemplateListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2913,19 +3009,20 @@ public function templateListWithHttpInfo(string $account_id = null, int $page = return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateListResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TemplateListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2942,9 +3039,11 @@ public function templateListWithHttpInfo(string $account_id = null, int $page = return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2957,6 +3056,7 @@ public function templateListWithHttpInfo(string $account_id = null, int $page = ); $e->setResponseObject($data); break; + } throw $e; } @@ -2967,17 +3067,17 @@ public function templateListWithHttpInfo(string $account_id = null, int $page = * * List Templates * - * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation + * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateList. This method will eventually become unavailable */ - public function templateListAsync(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['templateList'][0]) + public function templateListAsync($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['templateList'][0]) { return $this->templateListAsyncWithHttpInfo($account_id, $page, $page_size, $query, $contentType) ->then( @@ -2992,17 +3092,17 @@ function ($response) { * * List Templates * - * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation + * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateList. This method will eventually become unavailable */ - public function templateListAsyncWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['templateList'][0]) + public function templateListAsyncWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['templateList'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateListResponse'; $request = $this->templateListRequest($account_id, $page, $page_size, $query, $contentType); @@ -3012,9 +3112,9 @@ public function templateListAsyncWithHttpInfo(string $account_id = null, int $pa ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3023,7 +3123,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -3037,7 +3137,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -3046,24 +3146,29 @@ function ($exception) { /** * Create request for operation 'templateList' * - * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation + * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateList. This method will eventually become unavailable */ - public function templateListRequest(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['templateList'][0]) + public function templateListRequest($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['templateList'][0]) { + + + if ($page_size !== null && $page_size > 100) { - throw new InvalidArgumentException('invalid value for "$page_size" when calling TemplateApi.templateList, must be smaller than or equal to 100.'); + throw new \InvalidArgumentException('invalid value for "$page_size" when calling TemplateApi.templateList, must be smaller than or equal to 100.'); } if ($page_size !== null && $page_size < 1) { - throw new InvalidArgumentException('invalid value for "$page_size" when calling TemplateApi.templateList, must be bigger than or equal to 1.'); + throw new \InvalidArgumentException('invalid value for "$page_size" when calling TemplateApi.templateList, must be bigger than or equal to 1.'); } + + $resourcePath = '/template/list'; $formParams = []; @@ -3109,8 +3214,11 @@ public function templateListRequest(string $account_id = null, int $page = 1, in false // required ) ?? []); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -3124,7 +3232,7 @@ public function templateListRequest(string $account_id = null, int $page = 1, in foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -3138,8 +3246,9 @@ public function templateListRequest(string $account_id = null, int $page = 1, in } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3182,14 +3291,14 @@ public function templateListRequest(string $account_id = null, int $page = 1, in * * Remove User from Template * - * @param string $template_id The id of the Template to remove the Account's access to. (required) - * @param Model\TemplateRemoveUserRequest $template_remove_user_request template_remove_user_request (required) + * @param string $template_id The id of the Template to remove the Account's access to. (required) + * @param \Dropbox\Sign\Model\TemplateRemoveUserRequest $template_remove_user_request template_remove_user_request (required) * - * @return Model\TemplateGetResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function templateRemoveUser(string $template_id, Model\TemplateRemoveUserRequest $template_remove_user_request) + public function templateRemoveUser($template_id, $template_remove_user_request) { list($response) = $this->templateRemoveUserWithHttpInfo($template_id, $template_remove_user_request); return $response; @@ -3200,16 +3309,16 @@ public function templateRemoveUser(string $template_id, Model\TemplateRemoveUser * * Remove User from Template * - * @param string $template_id The id of the Template to remove the Account's access to. (required) - * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to remove the Account's access to. (required) + * @param \Dropbox\Sign\Model\TemplateRemoveUserRequest $template_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation * - * @return array of Model\TemplateGetResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::templateRemoveUser. This method will eventually become unavailable */ - public function templateRemoveUserWithHttpInfo(string $template_id, Model\TemplateRemoveUserRequest $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) + public function templateRemoveUserWithHttpInfo($template_id, $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) { $request = $this->templateRemoveUserRequest($template_id, $template_remove_user_request, $contentType); @@ -3221,14 +3330,14 @@ public function templateRemoveUserWithHttpInfo(string $template_id, Model\Templa } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -3241,14 +3350,14 @@ public function templateRemoveUserWithHttpInfo(string $template_id, Model\Templa sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3257,17 +3366,18 @@ public function templateRemoveUserWithHttpInfo(string $template_id, Model\Templa if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateGetResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TemplateGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3284,19 +3394,20 @@ public function templateRemoveUserWithHttpInfo(string $template_id, Model\Templa return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateGetResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3313,9 +3424,11 @@ public function templateRemoveUserWithHttpInfo(string $template_id, Model\Templa return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3328,6 +3441,7 @@ public function templateRemoveUserWithHttpInfo(string $template_id, Model\Templa ); $e->setResponseObject($data); break; + } throw $e; } @@ -3338,15 +3452,15 @@ public function templateRemoveUserWithHttpInfo(string $template_id, Model\Templa * * Remove User from Template * - * @param string $template_id The id of the Template to remove the Account's access to. (required) - * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to remove the Account's access to. (required) + * @param \Dropbox\Sign\Model\TemplateRemoveUserRequest $template_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateRemoveUser. This method will eventually become unavailable */ - public function templateRemoveUserAsync(string $template_id, Model\TemplateRemoveUserRequest $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) + public function templateRemoveUserAsync($template_id, $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) { return $this->templateRemoveUserAsyncWithHttpInfo($template_id, $template_remove_user_request, $contentType) ->then( @@ -3361,15 +3475,15 @@ function ($response) { * * Remove User from Template * - * @param string $template_id The id of the Template to remove the Account's access to. (required) - * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to remove the Account's access to. (required) + * @param \Dropbox\Sign\Model\TemplateRemoveUserRequest $template_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateRemoveUser. This method will eventually become unavailable */ - public function templateRemoveUserAsyncWithHttpInfo(string $template_id, Model\TemplateRemoveUserRequest $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) + public function templateRemoveUserAsyncWithHttpInfo($template_id, $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; $request = $this->templateRemoveUserRequest($template_id, $template_remove_user_request, $contentType); @@ -3379,9 +3493,9 @@ public function templateRemoveUserAsyncWithHttpInfo(string $template_id, Model\T ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3390,7 +3504,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -3404,7 +3518,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -3413,30 +3527,32 @@ function ($exception) { /** * Create request for operation 'templateRemoveUser' * - * @param string $template_id The id of the Template to remove the Account's access to. (required) - * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to remove the Account's access to. (required) + * @param \Dropbox\Sign\Model\TemplateRemoveUserRequest $template_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateRemoveUser. This method will eventually become unavailable */ - public function templateRemoveUserRequest(string $template_id, Model\TemplateRemoveUserRequest $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) + public function templateRemoveUserRequest($template_id, $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) { + // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_id when calling templateRemoveUser' ); } // verify the required parameter 'template_remove_user_request' is set if ($template_remove_user_request === null || (is_array($template_remove_user_request) && count($template_remove_user_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_remove_user_request when calling templateRemoveUser' ); } + $resourcePath = '/template/remove_user/{template_id}'; $formParams = []; $queryParams = []; @@ -3450,17 +3566,19 @@ public function templateRemoveUserRequest(string $template_id, Model\TemplateRem $multipart = !empty($formParams); + // path params if ($template_id !== null) { $resourcePath = str_replace( - '{template_id}', + '{' . 'template_id' . '}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -3468,7 +3586,7 @@ public function templateRemoveUserRequest(string $template_id, Model\TemplateRem // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_remove_user_request)); } else { $httpBody = $template_remove_user_request; @@ -3481,7 +3599,7 @@ public function templateRemoveUserRequest(string $template_id, Model\TemplateRem foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -3498,8 +3616,9 @@ public function templateRemoveUserRequest(string $template_id, Model\TemplateRem $payloadHook('multipart', $multipartContents, $template_remove_user_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3542,14 +3661,14 @@ public function templateRemoveUserRequest(string $template_id, Model\TemplateRem * * Update Template Files * - * @param string $template_id The ID of the template whose files to update. (required) - * @param Model\TemplateUpdateFilesRequest $template_update_files_request template_update_files_request (required) + * @param string $template_id The ID of the template whose files to update. (required) + * @param \Dropbox\Sign\Model\TemplateUpdateFilesRequest $template_update_files_request template_update_files_request (required) * - * @return Model\TemplateUpdateFilesResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\TemplateUpdateFilesResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function templateUpdateFiles(string $template_id, Model\TemplateUpdateFilesRequest $template_update_files_request) + public function templateUpdateFiles($template_id, $template_update_files_request) { list($response) = $this->templateUpdateFilesWithHttpInfo($template_id, $template_update_files_request); return $response; @@ -3560,16 +3679,16 @@ public function templateUpdateFiles(string $template_id, Model\TemplateUpdateFil * * Update Template Files * - * @param string $template_id The ID of the template whose files to update. (required) - * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation + * @param string $template_id The ID of the template whose files to update. (required) + * @param \Dropbox\Sign\Model\TemplateUpdateFilesRequest $template_update_files_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation * - * @return array of Model\TemplateUpdateFilesResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\TemplateUpdateFilesResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::templateUpdateFiles. This method will eventually become unavailable */ - public function templateUpdateFilesWithHttpInfo(string $template_id, Model\TemplateUpdateFilesRequest $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) + public function templateUpdateFilesWithHttpInfo($template_id, $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) { $request = $this->templateUpdateFilesRequest($template_id, $template_update_files_request, $contentType); @@ -3581,14 +3700,14 @@ public function templateUpdateFilesWithHttpInfo(string $template_id, Model\Templ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -3601,14 +3720,14 @@ public function templateUpdateFilesWithHttpInfo(string $template_id, Model\Templ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3617,17 +3736,18 @@ public function templateUpdateFilesWithHttpInfo(string $template_id, Model\Templ if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateUpdateFilesResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\TemplateUpdateFilesResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3644,19 +3764,20 @@ public function templateUpdateFilesWithHttpInfo(string $template_id, Model\Templ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateUpdateFilesResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\TemplateUpdateFilesResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3673,9 +3794,11 @@ public function templateUpdateFilesWithHttpInfo(string $template_id, Model\Templ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3688,6 +3811,7 @@ public function templateUpdateFilesWithHttpInfo(string $template_id, Model\Templ ); $e->setResponseObject($data); break; + } throw $e; } @@ -3698,15 +3822,15 @@ public function templateUpdateFilesWithHttpInfo(string $template_id, Model\Templ * * Update Template Files * - * @param string $template_id The ID of the template whose files to update. (required) - * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation + * @param string $template_id The ID of the template whose files to update. (required) + * @param \Dropbox\Sign\Model\TemplateUpdateFilesRequest $template_update_files_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateUpdateFiles. This method will eventually become unavailable */ - public function templateUpdateFilesAsync(string $template_id, Model\TemplateUpdateFilesRequest $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) + public function templateUpdateFilesAsync($template_id, $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) { return $this->templateUpdateFilesAsyncWithHttpInfo($template_id, $template_update_files_request, $contentType) ->then( @@ -3721,15 +3845,15 @@ function ($response) { * * Update Template Files * - * @param string $template_id The ID of the template whose files to update. (required) - * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation + * @param string $template_id The ID of the template whose files to update. (required) + * @param \Dropbox\Sign\Model\TemplateUpdateFilesRequest $template_update_files_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::templateUpdateFiles. This method will eventually become unavailable */ - public function templateUpdateFilesAsyncWithHttpInfo(string $template_id, Model\TemplateUpdateFilesRequest $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) + public function templateUpdateFilesAsyncWithHttpInfo($template_id, $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateUpdateFilesResponse'; $request = $this->templateUpdateFilesRequest($template_id, $template_update_files_request, $contentType); @@ -3739,9 +3863,9 @@ public function templateUpdateFilesAsyncWithHttpInfo(string $template_id, Model\ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3750,7 +3874,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -3764,7 +3888,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -3773,30 +3897,32 @@ function ($exception) { /** * Create request for operation 'templateUpdateFiles' * - * @param string $template_id The ID of the template whose files to update. (required) - * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation + * @param string $template_id The ID of the template whose files to update. (required) + * @param \Dropbox\Sign\Model\TemplateUpdateFilesRequest $template_update_files_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::templateUpdateFiles. This method will eventually become unavailable */ - public function templateUpdateFilesRequest(string $template_id, Model\TemplateUpdateFilesRequest $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) + public function templateUpdateFilesRequest($template_id, $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) { + // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_id when calling templateUpdateFiles' ); } // verify the required parameter 'template_update_files_request' is set if ($template_update_files_request === null || (is_array($template_update_files_request) && count($template_update_files_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $template_update_files_request when calling templateUpdateFiles' ); } + $resourcePath = '/template/update_files/{template_id}'; $formParams = []; $queryParams = []; @@ -3810,17 +3936,19 @@ public function templateUpdateFilesRequest(string $template_id, Model\TemplateUp $multipart = !empty($formParams); + // path params if ($template_id !== null) { $resourcePath = str_replace( - '{template_id}', + '{' . 'template_id' . '}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -3828,7 +3956,7 @@ public function templateUpdateFilesRequest(string $template_id, Model\TemplateUp // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_update_files_request)); } else { $httpBody = $template_update_files_request; @@ -3841,7 +3969,7 @@ public function templateUpdateFilesRequest(string $template_id, Model\TemplateUp foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -3858,8 +3986,9 @@ public function templateUpdateFilesRequest(string $template_id, Model\TemplateUp $payloadHook('multipart', $multipartContents, $template_update_files_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3900,8 +4029,8 @@ public function templateUpdateFilesRequest(string $template_id, Model\TemplateUp /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -3909,7 +4038,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -3925,8 +4054,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -3936,9 +4065,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -3957,8 +4086,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/UnclaimedDraftApi.php b/sdks/php/src/Api/UnclaimedDraftApi.php index 3886a87c5..3e8297f9a 100644 --- a/sdks/php/src/Api/UnclaimedDraftApi.php +++ b/sdks/php/src/Api/UnclaimedDraftApi.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,11 +28,6 @@ namespace Dropbox\Sign\Api; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\Model; -use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -38,34 +35,44 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use InvalidArgumentException; -use JsonException; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\ObjectSerializer; +use Dropbox\Sign\Model; use Psr\Http\Message\ResponseInterface; -use RuntimeException; /** * UnclaimedDraftApi Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class UnclaimedDraftApi { - /** @var ClientInterface */ + /** + * @var ClientInterface + */ protected $client; - /** @var Configuration */ + /** + * @var Configuration + */ protected $config; - /** @var HeaderSelector */ + /** + * @var HeaderSelector + */ protected $headerSelector; - /** @var int Host index */ - protected $hostIndex; - /** - * @var string[] * + * @var int Host index */ + protected $hostIndex; + + /** @var string[] $contentTypes **/ public const contentTypes = [ 'unclaimedDraftCreate' => [ 'application/json', @@ -88,13 +95,16 @@ class UnclaimedDraftApi protected $response; /** - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param Configuration $config + * @param ClientInterface $client + * @param HeaderSelector $selector + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - int $hostIndex = 0 + $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -108,7 +118,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex(int $hostIndex): void + public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } @@ -145,13 +155,13 @@ public function getResponse() * * Create Unclaimed Draft * - * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request unclaimed_draft_create_request (required) + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request unclaimed_draft_create_request (required) * - * @return Model\UnclaimedDraftCreateResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function unclaimedDraftCreate(Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request) + public function unclaimedDraftCreate($unclaimed_draft_create_request) { list($response) = $this->unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request); return $response; @@ -162,15 +172,15 @@ public function unclaimedDraftCreate(Model\UnclaimedDraftCreateRequest $unclaime * * Create Unclaimed Draft * - * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * - * @return array of Model\UnclaimedDraftCreateResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::unclaimedDraftCreate. This method will eventually become unavailable */ - public function unclaimedDraftCreateWithHttpInfo(Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) + public function unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) { $request = $this->unclaimedDraftCreateRequest($unclaimed_draft_create_request, $contentType); @@ -182,14 +192,14 @@ public function unclaimedDraftCreateWithHttpInfo(Model\UnclaimedDraftCreateReque } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -202,14 +212,14 @@ public function unclaimedDraftCreateWithHttpInfo(Model\UnclaimedDraftCreateReque sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -218,17 +228,18 @@ public function unclaimedDraftCreateWithHttpInfo(Model\UnclaimedDraftCreateReque if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -245,19 +256,20 @@ public function unclaimedDraftCreateWithHttpInfo(Model\UnclaimedDraftCreateReque return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -274,9 +286,11 @@ public function unclaimedDraftCreateWithHttpInfo(Model\UnclaimedDraftCreateReque return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -289,6 +303,7 @@ public function unclaimedDraftCreateWithHttpInfo(Model\UnclaimedDraftCreateReque ); $e->setResponseObject($data); break; + } throw $e; } @@ -299,14 +314,14 @@ public function unclaimedDraftCreateWithHttpInfo(Model\UnclaimedDraftCreateReque * * Create Unclaimed Draft * - * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreate. This method will eventually become unavailable */ - public function unclaimedDraftCreateAsync(Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) + public function unclaimedDraftCreateAsync($unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) { return $this->unclaimedDraftCreateAsyncWithHttpInfo($unclaimed_draft_create_request, $contentType) ->then( @@ -321,14 +336,14 @@ function ($response) { * * Create Unclaimed Draft * - * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreate. This method will eventually become unavailable */ - public function unclaimedDraftCreateAsyncWithHttpInfo(Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) + public function unclaimedDraftCreateAsyncWithHttpInfo($unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) { $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; $request = $this->unclaimedDraftCreateRequest($unclaimed_draft_create_request, $contentType); @@ -338,9 +353,9 @@ public function unclaimedDraftCreateAsyncWithHttpInfo(Model\UnclaimedDraftCreate ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -349,7 +364,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -363,7 +378,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -372,22 +387,24 @@ function ($exception) { /** * Create request for operation 'unclaimedDraftCreate' * - * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::unclaimedDraftCreate. This method will eventually become unavailable */ - public function unclaimedDraftCreateRequest(Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) + public function unclaimedDraftCreateRequest($unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) { + // verify the required parameter 'unclaimed_draft_create_request' is set if ($unclaimed_draft_create_request === null || (is_array($unclaimed_draft_create_request) && count($unclaimed_draft_create_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $unclaimed_draft_create_request when calling unclaimedDraftCreate' ); } + $resourcePath = '/unclaimed_draft/create'; $formParams = []; $queryParams = []; @@ -401,8 +418,11 @@ public function unclaimedDraftCreateRequest(Model\UnclaimedDraftCreateRequest $u $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -410,7 +430,7 @@ public function unclaimedDraftCreateRequest(Model\UnclaimedDraftCreateRequest $u // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($unclaimed_draft_create_request)); } else { $httpBody = $unclaimed_draft_create_request; @@ -423,7 +443,7 @@ public function unclaimedDraftCreateRequest(Model\UnclaimedDraftCreateRequest $u foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -440,8 +460,9 @@ public function unclaimedDraftCreateRequest(Model\UnclaimedDraftCreateRequest $u $payloadHook('multipart', $multipartContents, $unclaimed_draft_create_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -484,13 +505,13 @@ public function unclaimedDraftCreateRequest(Model\UnclaimedDraftCreateRequest $u * * Create Embedded Unclaimed Draft * - * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request unclaimed_draft_create_embedded_request (required) + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request unclaimed_draft_create_embedded_request (required) * - * @return Model\UnclaimedDraftCreateResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function unclaimedDraftCreateEmbedded(Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request) + public function unclaimedDraftCreateEmbedded($unclaimed_draft_create_embedded_request) { list($response) = $this->unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create_embedded_request); return $response; @@ -501,15 +522,15 @@ public function unclaimedDraftCreateEmbedded(Model\UnclaimedDraftCreateEmbeddedR * * Create Embedded Unclaimed Draft * - * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * - * @return array of Model\UnclaimedDraftCreateResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::unclaimedDraftCreateEmbedded. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedWithHttpInfo(Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) + public function unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) { $request = $this->unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embedded_request, $contentType); @@ -521,14 +542,14 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo(Model\UnclaimedDraftCre } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -541,14 +562,14 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo(Model\UnclaimedDraftCre sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -557,17 +578,18 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo(Model\UnclaimedDraftCre if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -584,19 +606,20 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo(Model\UnclaimedDraftCre return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -613,9 +636,11 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo(Model\UnclaimedDraftCre return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -628,6 +653,7 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo(Model\UnclaimedDraftCre ); $e->setResponseObject($data); break; + } throw $e; } @@ -638,14 +664,14 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo(Model\UnclaimedDraftCre * * Create Embedded Unclaimed Draft * - * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbedded. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedAsync(Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) + public function unclaimedDraftCreateEmbeddedAsync($unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) { return $this->unclaimedDraftCreateEmbeddedAsyncWithHttpInfo($unclaimed_draft_create_embedded_request, $contentType) ->then( @@ -660,14 +686,14 @@ function ($response) { * * Create Embedded Unclaimed Draft * - * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbedded. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedAsyncWithHttpInfo(Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) + public function unclaimedDraftCreateEmbeddedAsyncWithHttpInfo($unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) { $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; $request = $this->unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embedded_request, $contentType); @@ -677,9 +703,9 @@ public function unclaimedDraftCreateEmbeddedAsyncWithHttpInfo(Model\UnclaimedDra ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -688,7 +714,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -702,7 +728,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -711,22 +737,24 @@ function ($exception) { /** * Create request for operation 'unclaimedDraftCreateEmbedded' * - * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::unclaimedDraftCreateEmbedded. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedRequest(Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) + public function unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) { + // verify the required parameter 'unclaimed_draft_create_embedded_request' is set if ($unclaimed_draft_create_embedded_request === null || (is_array($unclaimed_draft_create_embedded_request) && count($unclaimed_draft_create_embedded_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $unclaimed_draft_create_embedded_request when calling unclaimedDraftCreateEmbedded' ); } + $resourcePath = '/unclaimed_draft/create_embedded'; $formParams = []; $queryParams = []; @@ -740,8 +768,11 @@ public function unclaimedDraftCreateEmbeddedRequest(Model\UnclaimedDraftCreateEm $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -749,7 +780,7 @@ public function unclaimedDraftCreateEmbeddedRequest(Model\UnclaimedDraftCreateEm // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($unclaimed_draft_create_embedded_request)); } else { $httpBody = $unclaimed_draft_create_embedded_request; @@ -762,7 +793,7 @@ public function unclaimedDraftCreateEmbeddedRequest(Model\UnclaimedDraftCreateEm foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -779,8 +810,9 @@ public function unclaimedDraftCreateEmbeddedRequest(Model\UnclaimedDraftCreateEm $payloadHook('multipart', $multipartContents, $unclaimed_draft_create_embedded_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -823,13 +855,13 @@ public function unclaimedDraftCreateEmbeddedRequest(Model\UnclaimedDraftCreateEm * * Create Embedded Unclaimed Draft with Template * - * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request unclaimed_draft_create_embedded_with_template_request (required) + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request unclaimed_draft_create_embedded_with_template_request (required) * - * @return Model\UnclaimedDraftCreateResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function unclaimedDraftCreateEmbeddedWithTemplate(Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request) + public function unclaimedDraftCreateEmbeddedWithTemplate($unclaimed_draft_create_embedded_with_template_request) { list($response) = $this->unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_draft_create_embedded_with_template_request); return $response; @@ -840,15 +872,15 @@ public function unclaimedDraftCreateEmbeddedWithTemplate(Model\UnclaimedDraftCre * * Create Embedded Unclaimed Draft with Template * - * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @return array of Model\UnclaimedDraftCreateResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::unclaimedDraftCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) + public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) { $request = $this->unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft_create_embedded_with_template_request, $contentType); @@ -860,14 +892,14 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(Model\Uncla } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -880,14 +912,14 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(Model\Uncla sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -896,17 +928,18 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(Model\Uncla if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -923,19 +956,20 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(Model\Uncla return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -952,9 +986,11 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(Model\Uncla return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -967,6 +1003,7 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(Model\Uncla ); $e->setResponseObject($data); break; + } throw $e; } @@ -977,14 +1014,14 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(Model\Uncla * * Create Embedded Unclaimed Draft with Template * - * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedWithTemplateAsync(Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) + public function unclaimedDraftCreateEmbeddedWithTemplateAsync($unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) { return $this->unclaimedDraftCreateEmbeddedWithTemplateAsyncWithHttpInfo($unclaimed_draft_create_embedded_with_template_request, $contentType) ->then( @@ -999,14 +1036,14 @@ function ($response) { * * Create Embedded Unclaimed Draft with Template * - * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedWithTemplateAsyncWithHttpInfo(Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) + public function unclaimedDraftCreateEmbeddedWithTemplateAsyncWithHttpInfo($unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) { $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; $request = $this->unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft_create_embedded_with_template_request, $contentType); @@ -1016,9 +1053,9 @@ public function unclaimedDraftCreateEmbeddedWithTemplateAsyncWithHttpInfo(Model\ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1027,7 +1064,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1041,7 +1078,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1050,22 +1087,24 @@ function ($exception) { /** * Create request for operation 'unclaimedDraftCreateEmbeddedWithTemplate' * - * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::unclaimedDraftCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedWithTemplateRequest(Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) + public function unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) { + // verify the required parameter 'unclaimed_draft_create_embedded_with_template_request' is set if ($unclaimed_draft_create_embedded_with_template_request === null || (is_array($unclaimed_draft_create_embedded_with_template_request) && count($unclaimed_draft_create_embedded_with_template_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $unclaimed_draft_create_embedded_with_template_request when calling unclaimedDraftCreateEmbeddedWithTemplate' ); } + $resourcePath = '/unclaimed_draft/create_embedded_with_template'; $formParams = []; $queryParams = []; @@ -1079,8 +1118,11 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest(Model\UnclaimedD $multipart = !empty($formParams); + + + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1088,7 +1130,7 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest(Model\UnclaimedD // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($unclaimed_draft_create_embedded_with_template_request)); } else { $httpBody = $unclaimed_draft_create_embedded_with_template_request; @@ -1101,7 +1143,7 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest(Model\UnclaimedD foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1118,8 +1160,9 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest(Model\UnclaimedD $payloadHook('multipart', $multipartContents, $unclaimed_draft_create_embedded_with_template_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1162,14 +1205,14 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest(Model\UnclaimedD * * Edit and Resend Unclaimed Draft * - * @param string $signature_request_id The ID of the signature request to edit and resend. (required) - * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request unclaimed_draft_edit_and_resend_request (required) + * @param string $signature_request_id The ID of the signature request to edit and resend. (required) + * @param \Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request unclaimed_draft_edit_and_resend_request (required) * - * @return Model\UnclaimedDraftCreateResponse - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse */ - public function unclaimedDraftEditAndResend(string $signature_request_id, Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request) + public function unclaimedDraftEditAndResend($signature_request_id, $unclaimed_draft_edit_and_resend_request) { list($response) = $this->unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $unclaimed_draft_edit_and_resend_request); return $response; @@ -1180,16 +1223,16 @@ public function unclaimedDraftEditAndResend(string $signature_request_id, Model\ * * Edit and Resend Unclaimed Draft * - * @param string $signature_request_id The ID of the signature request to edit and resend. (required) - * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation + * @param string $signature_request_id The ID of the signature request to edit and resend. (required) + * @param \Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation * - * @return array of Model\UnclaimedDraftCreateResponse, HTTP status code, HTTP response headers (array of strings) - * @throws ApiException on non-2xx response or if the response body is not in the expected format - * @throws InvalidArgumentException + * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format + * @throws \InvalidArgumentException + * @return array of \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) * @deprecated Prefer to use ::unclaimedDraftEditAndResend. This method will eventually become unavailable */ - public function unclaimedDraftEditAndResendWithHttpInfo(string $signature_request_id, Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) + public function unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) { $request = $this->unclaimedDraftEditAndResendRequest($signature_request_id, $unclaimed_draft_edit_and_resend_request, $contentType); @@ -1201,14 +1244,14 @@ public function unclaimedDraftEditAndResendWithHttpInfo(string $signature_reques } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string)$e->getResponse()->getBody() : null + $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int)$e->getCode(), + (int) $e->getCode(), null, null ); @@ -1221,14 +1264,14 @@ public function unclaimedDraftEditAndResendWithHttpInfo(string $signature_reques sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string)$request->getUri() + (string) $request->getUri() ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1237,17 +1280,18 @@ public function unclaimedDraftEditAndResendWithHttpInfo(string $signature_reques if ($result) { return $result; } + - switch ($statusCode) { + switch($statusCode) { case 200: if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1264,19 +1308,20 @@ public function unclaimedDraftEditAndResendWithHttpInfo(string $signature_reques return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $exception) { + } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1293,9 +1338,11 @@ public function unclaimedDraftEditAndResendWithHttpInfo(string $signature_reques return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1308,6 +1355,7 @@ public function unclaimedDraftEditAndResendWithHttpInfo(string $signature_reques ); $e->setResponseObject($data); break; + } throw $e; } @@ -1318,15 +1366,15 @@ public function unclaimedDraftEditAndResendWithHttpInfo(string $signature_reques * * Edit and Resend Unclaimed Draft * - * @param string $signature_request_id The ID of the signature request to edit and resend. (required) - * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation + * @param string $signature_request_id The ID of the signature request to edit and resend. (required) + * @param \Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftEditAndResend. This method will eventually become unavailable */ - public function unclaimedDraftEditAndResendAsync(string $signature_request_id, Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) + public function unclaimedDraftEditAndResendAsync($signature_request_id, $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) { return $this->unclaimedDraftEditAndResendAsyncWithHttpInfo($signature_request_id, $unclaimed_draft_edit_and_resend_request, $contentType) ->then( @@ -1341,15 +1389,15 @@ function ($response) { * * Edit and Resend Unclaimed Draft * - * @param string $signature_request_id The ID of the signature request to edit and resend. (required) - * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation + * @param string $signature_request_id The ID of the signature request to edit and resend. (required) + * @param \Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation * + * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface - * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftEditAndResend. This method will eventually become unavailable */ - public function unclaimedDraftEditAndResendAsyncWithHttpInfo(string $signature_request_id, Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) + public function unclaimedDraftEditAndResendAsyncWithHttpInfo($signature_request_id, $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) { $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; $request = $this->unclaimedDraftEditAndResendRequest($signature_request_id, $unclaimed_draft_edit_and_resend_request, $contentType); @@ -1359,9 +1407,9 @@ public function unclaimedDraftEditAndResendAsyncWithHttpInfo(string $signature_r ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1370,7 +1418,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; }, function ($exception) { @@ -1384,7 +1432,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string)$response->getBody() + (string) $response->getBody() ); } ); @@ -1393,30 +1441,32 @@ function ($exception) { /** * Create request for operation 'unclaimedDraftEditAndResend' * - * @param string $signature_request_id The ID of the signature request to edit and resend. (required) - * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation + * @param string $signature_request_id The ID of the signature request to edit and resend. (required) + * @param \Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation * - * @return Request - * @throws InvalidArgumentException + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request * @deprecated Prefer to use ::unclaimedDraftEditAndResend. This method will eventually become unavailable */ - public function unclaimedDraftEditAndResendRequest(string $signature_request_id, Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) + public function unclaimedDraftEditAndResendRequest($signature_request_id, $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) { + // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling unclaimedDraftEditAndResend' ); } // verify the required parameter 'unclaimed_draft_edit_and_resend_request' is set if ($unclaimed_draft_edit_and_resend_request === null || (is_array($unclaimed_draft_edit_and_resend_request) && count($unclaimed_draft_edit_and_resend_request) === 0)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( 'Missing the required parameter $unclaimed_draft_edit_and_resend_request when calling unclaimedDraftEditAndResend' ); } + $resourcePath = '/unclaimed_draft/edit_and_resend/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -1430,17 +1480,19 @@ public function unclaimedDraftEditAndResendRequest(string $signature_request_id, $multipart = !empty($formParams); + // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{signature_request_id}', + '{' . 'signature_request_id' . '}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } + $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json'], + $multipart ? ['multipart/form-data'] : ['application/json', ], $contentType, $multipart ); @@ -1448,7 +1500,7 @@ public function unclaimedDraftEditAndResendRequest(string $signature_request_id, // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the body + # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($unclaimed_draft_edit_and_resend_request)); } else { $httpBody = $unclaimed_draft_edit_and_resend_request; @@ -1461,7 +1513,7 @@ public function unclaimedDraftEditAndResendRequest(string $signature_request_id, foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem, + 'contents' => $formParamValueItem ]; } } @@ -1478,8 +1530,9 @@ public function unclaimedDraftEditAndResendRequest(string $signature_request_id, $payloadHook('multipart', $multipartContents, $unclaimed_draft_edit_and_resend_request); } $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - // if Content-Type contains "application/json", json_encode the form parameters + # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1520,8 +1573,8 @@ public function unclaimedDraftEditAndResendRequest(string $signature_request_id, /** * Create http client option * + * @throws \RuntimeException on file opening failure * @return array of http client options - * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -1529,7 +1582,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -1545,8 +1598,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -1556,9 +1609,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); // stream goes to serializer + $content = $response->getBody(); //stream goes to serializer } else { - $content = (string)$response->getBody(); + $content = (string) $response->getBody(); } return [ @@ -1577,8 +1630,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/ApiException.php b/sdks/php/src/ApiException.php index 3d4a49ca7..df2c4cc9e 100644 --- a/sdks/php/src/ApiException.php +++ b/sdks/php/src/ApiException.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,21 +28,22 @@ namespace Dropbox\Sign; -use Exception; -use stdClass; +use \Exception; /** * ApiException Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class ApiException extends Exception { /** * The HTTP body of the server response either as Json or string. * - * @var stdClass|string|null + * @var \stdClass|string|null */ protected $responseBody; @@ -61,12 +64,12 @@ class ApiException extends Exception /** * Constructor * - * @param string $message Error message - * @param int $code HTTP status code - * @param string[][]|null $responseHeaders HTTP response header - * @param stdClass|string|null $responseBody HTTP decoded body of the server response either as \stdClass or string + * @param string $message Error message + * @param int $code HTTP status code + * @param string[][]|null $responseHeaders HTTP response header + * @param \stdClass|string|null $responseBody HTTP decoded body of the server response either as \stdClass or string */ - public function __construct(string $message = '', int $code = 0, ?array $responseHeaders = [], $responseBody = null) + public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null) { parent::__construct($message, $code); $this->responseHeaders = $responseHeaders; @@ -86,7 +89,7 @@ public function getResponseHeaders() /** * Gets the HTTP body of the server response either as Json or string * - * @return stdClass|string|null HTTP body of the server response either as \stdClass or string + * @return \stdClass|string|null HTTP body of the server response either as \stdClass or string */ public function getResponseBody() { @@ -97,6 +100,8 @@ public function getResponseBody() * Sets the deserialized response object (during deserialization) * * @param string|int|object|array|mixed $obj Deserialized response object + * + * @return void */ public function setResponseObject($obj) { diff --git a/sdks/php/src/Configuration.php b/sdks/php/src/Configuration.php index 204b66994..571f1482e 100644 --- a/sdks/php/src/Configuration.php +++ b/sdks/php/src/Configuration.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,21 +28,23 @@ namespace Dropbox\Sign; -use InvalidArgumentException; - /** * Configuration Class Doc Comment * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class Configuration { public const BOOLEAN_FORMAT_INT = 'int'; public const BOOLEAN_FORMAT_STRING = 'string'; - /** @var Configuration */ + /** + * @var Configuration + */ private static $defaultConfiguration; /** @@ -128,7 +132,7 @@ class Configuration protected $options = []; /** @var ?callable */ - protected $payloadHook; + protected $payloadHook = null; /** * Constructor @@ -146,7 +150,7 @@ public function __construct() * * @return $this */ - protected function setApiKey(string $apiKeyIdentifier, string $key) + protected function setApiKey($apiKeyIdentifier, $key) { $this->apiKeys[$apiKeyIdentifier] = $key; return $this; @@ -157,9 +161,9 @@ protected function setApiKey(string $apiKeyIdentifier, string $key) * * @param string $apiKeyIdentifier API key identifier (authentication scheme) * - * @return string|null API key or token + * @return null|string API key or token */ - protected function getApiKey(string $apiKeyIdentifier) + protected function getApiKey($apiKeyIdentifier) { return isset($this->apiKeys[$apiKeyIdentifier]) ? $this->apiKeys[$apiKeyIdentifier] : null; } @@ -172,7 +176,7 @@ protected function getApiKey(string $apiKeyIdentifier) * * @return $this */ - protected function setApiKeyPrefix(string $apiKeyIdentifier, string $prefix) + protected function setApiKeyPrefix($apiKeyIdentifier, $prefix) { $this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix; return $this; @@ -183,9 +187,9 @@ protected function setApiKeyPrefix(string $apiKeyIdentifier, string $prefix) * * @param string $apiKeyIdentifier API key identifier (authentication scheme) * - * @return string|null + * @return null|string */ - protected function getApiKeyPrefix(string $apiKeyIdentifier) + protected function getApiKeyPrefix($apiKeyIdentifier) { return isset($this->apiKeyPrefixes[$apiKeyIdentifier]) ? $this->apiKeyPrefixes[$apiKeyIdentifier] : null; } @@ -197,7 +201,7 @@ protected function getApiKeyPrefix(string $apiKeyIdentifier) * * @return $this */ - public function setAccessToken(string $accessToken) + public function setAccessToken($accessToken) { $this->accessToken = $accessToken; return $this; @@ -244,7 +248,7 @@ public function getBooleanFormatForQueryString(): string * * @return $this */ - public function setUsername(string $username) + public function setUsername($username) { $this->username = $username; return $this; @@ -267,7 +271,7 @@ public function getUsername() * * @return $this */ - protected function setPassword(string $password) + protected function setPassword($password) { $this->password = $password; return $this; @@ -290,7 +294,7 @@ protected function getPassword() * * @return $this */ - public function setHost(string $host) + public function setHost($host) { $this->host = $host; return $this; @@ -311,13 +315,13 @@ public function getHost() * * @param string $userAgent the user agent of the api client * + * @throws \InvalidArgumentException * @return $this - * @throws InvalidArgumentException */ - public function setUserAgent(string $userAgent) + public function setUserAgent($userAgent) { if (!is_string($userAgent)) { - throw new InvalidArgumentException('User-agent must be a string.'); + throw new \InvalidArgumentException('User-agent must be a string.'); } $this->userAgent = $userAgent; @@ -341,7 +345,7 @@ public function getUserAgent() * * @return $this */ - public function setDebug(bool $debug) + public function setDebug($debug) { $this->debug = $debug; return $this; @@ -364,7 +368,7 @@ public function getDebug() * * @return $this */ - public function setDebugFile(string $debugFile) + public function setDebugFile($debugFile) { $this->debugFile = $debugFile; return $this; @@ -387,7 +391,7 @@ public function getDebugFile() * * @return $this */ - public function setTempFolderPath(string $tempFolderPath) + public function setTempFolderPath($tempFolderPath) { $this->tempFolderPath = $tempFolderPath; return $this; @@ -421,6 +425,8 @@ public static function getDefaultConfiguration() * Sets the default configuration instance * * @param Configuration $config An instance of the Configuration Object + * + * @return void */ public static function setDefaultConfiguration(Configuration $config) { @@ -434,7 +440,7 @@ public static function setDefaultConfiguration(Configuration $config) */ public static function toDebugReport() { - $report = 'PHP SDK (Dropbox\Sign) Debug Report:' . PHP_EOL; + $report = 'PHP SDK (Dropbox\Sign) Debug Report:' . PHP_EOL; $report .= ' OS: ' . php_uname() . PHP_EOL; $report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL; $report .= ' The version of the OpenAPI document: 3.0.0' . PHP_EOL; @@ -447,11 +453,11 @@ public static function toDebugReport() /** * Get API key (with prefix if set) * - * @param string $apiKeyIdentifier name of apikey + * @param string $apiKeyIdentifier name of apikey * - * @return string|null API key with the prefix + * @return null|string API key with the prefix */ - protected function getApiKeyWithPrefix(string $apiKeyIdentifier) + protected function getApiKeyWithPrefix($apiKeyIdentifier) { $prefix = $this->getApiKeyPrefix($apiKeyIdentifier); $apiKey = $this->getApiKey($apiKeyIdentifier); @@ -478,21 +484,21 @@ public function getHostSettings() { return [ [ - 'url' => 'https://api.hellosign.com/v3', - 'description' => 'No description provided', - ], + "url" => "https://api.hellosign.com/v3", + "description" => "No description provided", + ] ]; } /** - * Returns URL based on host settings, index and variables - * - * @param array $hostSettings array of host settings, generated from getHostSettings() or equivalent from the API clients - * @param int $hostIndex index of the host settings - * @param array|null $variables hash of variable and the corresponding value (optional) - * @return string URL based on host settings - */ - public static function getHostString(array $hostSettings, int $hostIndex, array $variables = null) + * Returns URL based on host settings, index and variables + * + * @param array $hostSettings array of host settings, generated from getHostSettings() or equivalent from the API clients + * @param int $hostIndex index of the host settings + * @param array|null $variables hash of variable and the corresponding value (optional) + * @return string URL based on host settings + */ + public static function getHostString(array $hostSettings, $hostIndex, array $variables = null) { if (null === $variables) { $variables = []; @@ -500,23 +506,23 @@ public static function getHostString(array $hostSettings, int $hostIndex, array // check array index out of bound if ($hostIndex < 0 || $hostIndex >= count($hostSettings)) { - throw new InvalidArgumentException("Invalid index {$hostIndex} when selecting the host. Must be less than " . count($hostSettings)); + throw new \InvalidArgumentException("Invalid index $hostIndex when selecting the host. Must be less than ".count($hostSettings)); } $host = $hostSettings[$hostIndex]; - $url = $host['url']; + $url = $host["url"]; // go through variable and assign a value - foreach ($host['variables'] ?? [] as $name => $variable) { + foreach ($host["variables"] ?? [] as $name => $variable) { if (array_key_exists($name, $variables)) { // check to see if it's in the variables provided by the user - if (!isset($variable['enum_values']) || in_array($variables[$name], $variable['enum_values'], true)) { // check to see if the value is in the enum - $url = str_replace('{' . $name . '}', $variables[$name], $url); + if (!isset($variable['enum_values']) || in_array($variables[$name], $variable["enum_values"], true)) { // check to see if the value is in the enum + $url = str_replace("{".$name."}", $variables[$name], $url); } else { - throw new InvalidArgumentException("The variable `{$name}` in the host URL has invalid value " . $variables[$name] . '. Must be ' . join(',', $variable['enum_values']) . '.'); + throw new \InvalidArgumentException("The variable `$name` in the host URL has invalid value ".$variables[$name].". Must be ".join(',', $variable["enum_values"])."."); } } else { // use default value - $url = str_replace('{' . $name . '}', $variable['default_value'], $url); + $url = str_replace("{".$name."}", $variable["default_value"], $url); } } @@ -526,11 +532,11 @@ public static function getHostString(array $hostSettings, int $hostIndex, array /** * Returns URL based on the index and variables * - * @param int $index index of the host settings - * @param array|null $variables hash of variable and the corresponding value (optional) - * @return string URL based on host settings + * @param int $index index of the host settings + * @param array|null $variables hash of variable and the corresponding value (optional) + * @return string URL based on host settings */ - public function getHostFromSettings(int $index, ?array $variables = null) + public function getHostFromSettings($index, $variables = null) { return self::getHostString($this->getHostSettings(), $index, $variables); } @@ -544,6 +550,8 @@ public function setOptions(array $options): self /** * Get extra request options + * + * @return array */ public function getOptions(): array { diff --git a/sdks/php/src/EventCallbackHelper.php b/sdks/php/src/EventCallbackHelper.php index 16e76ec8b..81b5960a5 100644 --- a/sdks/php/src/EventCallbackHelper.php +++ b/sdks/php/src/EventCallbackHelper.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -31,7 +33,9 @@ * EventCallbackHelper Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ abstract class EventCallbackHelper { diff --git a/sdks/php/src/HeaderSelector.php b/sdks/php/src/HeaderSelector.php index fe1faf2c1..98a8891b6 100644 --- a/sdks/php/src/HeaderSelector.php +++ b/sdks/php/src/HeaderSelector.php @@ -4,7 +4,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -30,12 +32,16 @@ * HeaderSelector Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class HeaderSelector { /** - * @param string[] $accept + * @param string[] $accept + * @param string $contentType + * @param bool $isMultipart * @return string[] */ public function selectHeaders(array $accept, string $contentType, bool $isMultipart): array @@ -48,7 +54,7 @@ public function selectHeaders(array $accept, string $contentType, bool $isMultip } if (!$isMultipart) { - if ($contentType === '') { + if($contentType === '') { $contentType = 'application/json'; } @@ -63,41 +69,41 @@ public function selectHeaders(array $accept, string $contentType, bool $isMultip * * @param string[] $accept Array of header * - * @return string|null Accept (e.g. application/json) + * @return null|string Accept (e.g. application/json) */ private function selectAcceptHeader(array $accept): ?string { - // filter out empty entries + # filter out empty entries $accept = array_filter($accept); if (count($accept) === 0) { return null; } - // If there's only one Accept header, just use it + # If there's only one Accept header, just use it if (count($accept) === 1) { return reset($accept); } - // If none of the available Accept headers is of type "json", then just use all them + # If none of the available Accept headers is of type "json", then just use all them $headersWithJson = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept); if (count($headersWithJson) === 0) { return implode(',', $accept); } - // If we got here, then we need add quality values (weight), as described in IETF RFC 9110, Items 12.4.2/12.5.1, - // to give the highest priority to json-like headers - recalculating the existing ones, if needed + # If we got here, then we need add quality values (weight), as described in IETF RFC 9110, Items 12.4.2/12.5.1, + # to give the highest priority to json-like headers - recalculating the existing ones, if needed return $this->getAcceptHeaderWithAdjustedWeight($accept, $headersWithJson); } /** - * Create an Accept header string from the given "Accept" headers array, recalculating all weights - * - * @param string[] $accept Array of Accept Headers - * @param string[] $headersWithJson Array of Accept Headers of type "json" - * - * @return string "Accept" Header (e.g. "application/json, text/html; q=0.9") - */ + * Create an Accept header string from the given "Accept" headers array, recalculating all weights + * + * @param string[] $accept Array of Accept Headers + * @param string[] $headersWithJson Array of Accept Headers of type "json" + * + * @return string "Accept" Header (e.g. "application/json, text/html; q=0.9") + */ private function getAcceptHeaderWithAdjustedWeight(array $accept, array $headersWithJson): string { $processedHeaders = [ @@ -107,6 +113,7 @@ private function getAcceptHeaderWithAdjustedWeight(array $accept, array $headers ]; foreach ($accept as $header) { + $headerData = $this->getHeaderAndWeight($header); if (stripos($headerData['header'], 'application/json') === 0) { @@ -123,7 +130,7 @@ private function getAcceptHeaderWithAdjustedWeight(array $accept, array $headers $hasMoreThan28Headers = count($accept) > 28; - foreach ($processedHeaders as $headers) { + foreach($processedHeaders as $headers) { if (count($headers) > 0) { $acceptHeaders[] = $this->adjustWeight($headers, $currentWeight, $hasMoreThan28Headers); } @@ -143,7 +150,7 @@ private function getAcceptHeaderWithAdjustedWeight(array $accept, array $headers */ private function getHeaderAndWeight(string $header): array { - // matches headers with weight, splitting the header and the weight in $outputArray + # matches headers with weight, splitting the header and the weight in $outputArray if (preg_match('/(.*);\s*q=(1(?:\.0+)?|0\.\d+)$/', $header, $outputArray) === 1) { $headerData = [ 'header' => $outputArray[1], @@ -160,7 +167,9 @@ private function getHeaderAndWeight(string $header): array } /** - * @param array[] $headers + * @param array[] $headers + * @param float $currentWeight + * @param bool $hasMoreThan28Headers * @return string[] array of adjusted "Accept" headers */ private function adjustWeight(array $headers, float &$currentWeight, bool $hasMoreThan28Headers): array @@ -171,7 +180,8 @@ private function adjustWeight(array $headers, float &$currentWeight, bool $hasMo $acceptHeaders = []; foreach ($headers as $index => $header) { - if ($index > 0 && $headers[$index - 1]['weight'] > $header['weight']) { + if($index > 0 && $headers[$index - 1]['weight'] > $header['weight']) + { $currentWeight = $this->getNextWeight($currentWeight, $hasMoreThan28Headers); } @@ -185,9 +195,14 @@ private function adjustWeight(array $headers, float &$currentWeight, bool $hasMo return $acceptHeaders; } + /** + * @param string $header + * @param int $weight + * @return string + */ private function buildAcceptHeader(string $header, int $weight): string { - if ($weight === 1000) { + if($weight === 1000) { return $header; } @@ -212,7 +227,9 @@ private function buildAcceptHeader(string $header, int $weight): string * if there is a maximum of 28 "Accept" headers. If we have more than that (which is extremely unlikely), then we fall back to a 1-by-1 * decrement rule, which will result in quality codes like "q=0.999", "q=0.998" etc. * - * @param int $currentWeight varying from 1 to 1000 (will be divided by 1000 to build the quality value) + * @param int $currentWeight varying from 1 to 1000 (will be divided by 1000 to build the quality value) + * @param bool $hasMoreThan28Headers + * @return int */ public function getNextWeight(int $currentWeight, bool $hasMoreThan28Headers): int { @@ -224,6 +241,6 @@ public function getNextWeight(int $currentWeight, bool $hasMoreThan28Headers): i return $currentWeight - 1; } - return $currentWeight - 10 ** floor(log10($currentWeight - 1)); + return $currentWeight - 10 ** floor( log10($currentWeight - 1) ); } } diff --git a/sdks/php/src/Model/AccountCreateRequest.php b/sdks/php/src/Model/AccountCreateRequest.php index f4b927310..443c56c08 100644 --- a/sdks/php/src/Model/AccountCreateRequest.php +++ b/sdks/php/src/Model/AccountCreateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * AccountCreateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class AccountCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'email_address' => 'string', 'client_id' => 'string', 'client_secret' => 'string', - 'locale' => 'string', + 'locale' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'email_address' => 'email', 'client_id' => null, 'client_secret' => null, - 'locale' => null, + 'locale' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'email_address' => false, 'client_id' => false, 'client_secret' => false, - 'locale' => false, + 'locale' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'email_address', 'client_id' => 'client_id', 'client_secret' => 'client_secret', - 'locale' => 'locale', + 'locale' => 'locale' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'setEmailAddress', 'client_id' => 'setClientId', 'client_secret' => 'setClientSecret', - 'locale' => 'setLocale', + 'locale' => 'setLocale' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'getEmailAddress', 'client_id' => 'getClientId', 'client_secret' => 'getClientSecret', - 'locale' => 'getLocale', + 'locale' => 'getLocale' ]; /** @@ -238,6 +247,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -259,33 +269,34 @@ public function __construct(array $data = null) $this->setIfExists('locale', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): AccountCreateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): AccountCreateRequest { /** @var AccountCreateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, AccountCreateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -321,6 +332,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets email_address * @@ -334,14 +346,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address which will be associated with the new Account + * @param string $email_address The email address which will be associated with the new Account. * * @return self */ - public function setEmailAddress(string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -365,10 +377,10 @@ public function getClientId() * * @return self */ - public function setClientId(?string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -392,10 +404,10 @@ public function getClientSecret() * * @return self */ - public function setClientSecret(?string $client_secret) + public function setClientSecret($client_secret) { if (is_null($client_secret)) { - throw new InvalidArgumentException('non-nullable client_secret cannot be null'); + throw new \InvalidArgumentException('non-nullable client_secret cannot be null'); } $this->container['client_secret'] = $client_secret; @@ -419,22 +431,23 @@ public function getLocale() * * @return self */ - public function setLocale(?string $locale) + public function setLocale($locale) { if (is_null($locale)) { - throw new InvalidArgumentException('non-nullable locale cannot be null'); + throw new \InvalidArgumentException('non-nullable locale cannot be null'); } $this->container['locale'] = $locale; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -443,11 +456,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -458,8 +471,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -472,9 +487,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -482,15 +499,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -516,3 +533,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/AccountCreateResponse.php b/sdks/php/src/Model/AccountCreateResponse.php index 66e9a34d4..62cbb213f 100644 --- a/sdks/php/src/Model/AccountCreateResponse.php +++ b/sdks/php/src/Model/AccountCreateResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * AccountCreateResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountCreateResponse implements ModelInterface, ArrayAccess, JsonSerializable +class AccountCreateResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountCreateResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account' => '\Dropbox\Sign\Model\AccountResponse', 'oauth_data' => '\Dropbox\Sign\Model\OAuthTokenResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account' => null, 'oauth_data' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account' => false, 'oauth_data' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'account' => 'account', 'oauth_data' => 'oauth_data', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'account' => 'setAccount', 'oauth_data' => 'setOauthData', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'account' => 'getAccount', 'oauth_data' => 'getOauthData', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): AccountCreateResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): AccountCreateResponse { /** @var AccountCreateResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, AccountCreateResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,10 +325,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account * - * @return AccountResponse + * @return \Dropbox\Sign\Model\AccountResponse */ public function getAccount() { @@ -327,14 +339,14 @@ public function getAccount() /** * Sets account * - * @param AccountResponse $account account + * @param \Dropbox\Sign\Model\AccountResponse $account account * * @return self */ - public function setAccount(AccountResponse $account) + public function setAccount($account) { if (is_null($account)) { - throw new InvalidArgumentException('non-nullable account cannot be null'); + throw new \InvalidArgumentException('non-nullable account cannot be null'); } $this->container['account'] = $account; @@ -344,7 +356,7 @@ public function setAccount(AccountResponse $account) /** * Gets oauth_data * - * @return OAuthTokenResponse|null + * @return \Dropbox\Sign\Model\OAuthTokenResponse|null */ public function getOauthData() { @@ -354,14 +366,14 @@ public function getOauthData() /** * Sets oauth_data * - * @param OAuthTokenResponse|null $oauth_data oauth_data + * @param \Dropbox\Sign\Model\OAuthTokenResponse|null $oauth_data oauth_data * * @return self */ - public function setOauthData(?OAuthTokenResponse $oauth_data) + public function setOauthData($oauth_data) { if (is_null($oauth_data)) { - throw new InvalidArgumentException('non-nullable oauth_data cannot be null'); + throw new \InvalidArgumentException('non-nullable oauth_data cannot be null'); } $this->container['oauth_data'] = $oauth_data; @@ -371,7 +383,7 @@ public function setOauthData(?OAuthTokenResponse $oauth_data) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -381,26 +393,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -409,11 +422,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -424,8 +437,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -438,9 +453,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -448,15 +465,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -482,3 +499,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/AccountGetResponse.php b/sdks/php/src/Model/AccountGetResponse.php index b59da1285..625f9b67a 100644 --- a/sdks/php/src/Model/AccountGetResponse.php +++ b/sdks/php/src/Model/AccountGetResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * AccountGetResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountGetResponse implements ModelInterface, ArrayAccess, JsonSerializable +class AccountGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account' => '\Dropbox\Sign\Model\AccountResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account' => 'account', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account' => 'setAccount', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account' => 'getAccount', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): AccountGetResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): AccountGetResponse { /** @var AccountGetResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, AccountGetResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account * - * @return AccountResponse + * @return \Dropbox\Sign\Model\AccountResponse */ public function getAccount() { @@ -320,14 +332,14 @@ public function getAccount() /** * Sets account * - * @param AccountResponse $account account + * @param \Dropbox\Sign\Model\AccountResponse $account account * * @return self */ - public function setAccount(AccountResponse $account) + public function setAccount($account) { if (is_null($account)) { - throw new InvalidArgumentException('non-nullable account cannot be null'); + throw new \InvalidArgumentException('non-nullable account cannot be null'); } $this->container['account'] = $account; @@ -337,7 +349,7 @@ public function setAccount(AccountResponse $account) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/AccountResponse.php b/sdks/php/src/Model/AccountResponse.php index 3fb1a1869..3f0e35060 100644 --- a/sdks/php/src/Model/AccountResponse.php +++ b/sdks/php/src/Model/AccountResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,35 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * AccountResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable +class AccountResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', @@ -67,16 +68,16 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable 'role_code' => 'string', 'team_id' => 'string', 'locale' => 'string', - 'usage' => '\Dropbox\Sign\Model\AccountResponseUsage', + 'usage' => '\Dropbox\Sign\Model\AccountResponseUsage' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => null, @@ -88,14 +89,14 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable 'role_code' => null, 'team_id' => null, 'locale' => null, - 'usage' => null, + 'usage' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, @@ -107,14 +108,14 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable 'role_code' => true, 'team_id' => true, 'locale' => true, - 'usage' => false, + 'usage' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -139,6 +140,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -148,7 +151,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -158,7 +161,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -167,6 +170,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -175,6 +181,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -198,7 +207,7 @@ public function isNullableSetToNull(string $property): bool 'role_code' => 'role_code', 'team_id' => 'team_id', 'locale' => 'locale', - 'usage' => 'usage', + 'usage' => 'usage' ]; /** @@ -217,7 +226,7 @@ public function isNullableSetToNull(string $property): bool 'role_code' => 'setRoleCode', 'team_id' => 'setTeamId', 'locale' => 'setLocale', - 'usage' => 'setUsage', + 'usage' => 'setUsage' ]; /** @@ -236,7 +245,7 @@ public function isNullableSetToNull(string $property): bool 'role_code' => 'getRoleCode', 'team_id' => 'getTeamId', 'locale' => 'getLocale', - 'usage' => 'getUsage', + 'usage' => 'getUsage' ]; /** @@ -280,6 +289,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -308,33 +318,34 @@ public function __construct(array $data = null) $this->setIfExists('usage', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): AccountResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): AccountResponse { /** @var AccountResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, AccountResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -351,7 +362,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -365,6 +378,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account_id * @@ -382,10 +396,10 @@ public function getAccountId() * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -405,14 +419,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address the email address associated with the Account + * @param string|null $email_address The email address associated with the Account. * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -432,14 +446,14 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool|null $is_locked returns `true` if the user has been locked out of their account by a team admin + * @param bool|null $is_locked Returns `true` if the user has been locked out of their account by a team admin. * * @return self */ - public function setIsLocked(?bool $is_locked) + public function setIsLocked($is_locked) { if (is_null($is_locked)) { - throw new InvalidArgumentException('non-nullable is_locked cannot be null'); + throw new \InvalidArgumentException('non-nullable is_locked cannot be null'); } $this->container['is_locked'] = $is_locked; @@ -459,14 +473,14 @@ public function getIsPaidHs() /** * Sets is_paid_hs * - * @param bool|null $is_paid_hs returns `true` if the user has a paid Dropbox Sign account + * @param bool|null $is_paid_hs Returns `true` if the user has a paid Dropbox Sign account. * * @return self */ - public function setIsPaidHs(?bool $is_paid_hs) + public function setIsPaidHs($is_paid_hs) { if (is_null($is_paid_hs)) { - throw new InvalidArgumentException('non-nullable is_paid_hs cannot be null'); + throw new \InvalidArgumentException('non-nullable is_paid_hs cannot be null'); } $this->container['is_paid_hs'] = $is_paid_hs; @@ -486,14 +500,14 @@ public function getIsPaidHf() /** * Sets is_paid_hf * - * @param bool|null $is_paid_hf returns `true` if the user has a paid HelloFax account + * @param bool|null $is_paid_hf Returns `true` if the user has a paid HelloFax account. * * @return self */ - public function setIsPaidHf(?bool $is_paid_hf) + public function setIsPaidHf($is_paid_hf) { if (is_null($is_paid_hf)) { - throw new InvalidArgumentException('non-nullable is_paid_hf cannot be null'); + throw new \InvalidArgumentException('non-nullable is_paid_hf cannot be null'); } $this->container['is_paid_hf'] = $is_paid_hf; @@ -503,7 +517,7 @@ public function setIsPaidHf(?bool $is_paid_hf) /** * Gets quotas * - * @return AccountResponseQuotas|null + * @return \Dropbox\Sign\Model\AccountResponseQuotas|null */ public function getQuotas() { @@ -513,14 +527,14 @@ public function getQuotas() /** * Sets quotas * - * @param AccountResponseQuotas|null $quotas quotas + * @param \Dropbox\Sign\Model\AccountResponseQuotas|null $quotas quotas * * @return self */ - public function setQuotas(?AccountResponseQuotas $quotas) + public function setQuotas($quotas) { if (is_null($quotas)) { - throw new InvalidArgumentException('non-nullable quotas cannot be null'); + throw new \InvalidArgumentException('non-nullable quotas cannot be null'); } $this->container['quotas'] = $quotas; @@ -540,18 +554,18 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url the URL that Dropbox Sign events will `POST` to + * @param string|null $callback_url The URL that Dropbox Sign events will `POST` to. * * @return self */ - public function setCallbackUrl(?string $callback_url) + public function setCallbackUrl($callback_url) { if (is_null($callback_url)) { array_push($this->openAPINullablesSetToNull, 'callback_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('callback_url', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -574,18 +588,18 @@ public function getRoleCode() /** * Sets role_code * - * @param string|null $role_code the membership role for the team + * @param string|null $role_code The membership role for the team. * * @return self */ - public function setRoleCode(?string $role_code) + public function setRoleCode($role_code) { if (is_null($role_code)) { array_push($this->openAPINullablesSetToNull, 'role_code'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('role_code', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -608,18 +622,18 @@ public function getTeamId() /** * Sets team_id * - * @param string|null $team_id the id of the team account belongs to + * @param string|null $team_id The id of the team account belongs to. * * @return self */ - public function setTeamId(?string $team_id) + public function setTeamId($team_id) { if (is_null($team_id)) { array_push($this->openAPINullablesSetToNull, 'team_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('team_id', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -646,14 +660,14 @@ public function getLocale() * * @return self */ - public function setLocale(?string $locale) + public function setLocale($locale) { if (is_null($locale)) { array_push($this->openAPINullablesSetToNull, 'locale'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('locale', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -666,7 +680,7 @@ public function setLocale(?string $locale) /** * Gets usage * - * @return AccountResponseUsage|null + * @return \Dropbox\Sign\Model\AccountResponseUsage|null */ public function getUsage() { @@ -676,26 +690,27 @@ public function getUsage() /** * Sets usage * - * @param AccountResponseUsage|null $usage usage + * @param \Dropbox\Sign\Model\AccountResponseUsage|null $usage usage * * @return self */ - public function setUsage(?AccountResponseUsage $usage) + public function setUsage($usage) { if (is_null($usage)) { - throw new InvalidArgumentException('non-nullable usage cannot be null'); + throw new \InvalidArgumentException('non-nullable usage cannot be null'); } $this->container['usage'] = $usage; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -704,11 +719,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -719,8 +734,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -733,9 +750,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -743,15 +762,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -777,3 +796,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/AccountResponseQuotas.php b/sdks/php/src/Model/AccountResponseQuotas.php index 85d004055..b4dff9e73 100644 --- a/sdks/php/src/Model/AccountResponseQuotas.php +++ b/sdks/php/src/Model/AccountResponseQuotas.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,79 +29,79 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * AccountResponseQuotas Class Doc Comment * * @category Class * @description Details concerning remaining monthly quotas. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountResponseQuotas implements ModelInterface, ArrayAccess, JsonSerializable +class AccountResponseQuotas implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountResponseQuotas'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'api_signature_requests_left' => 'int', 'documents_left' => 'int', 'templates_total' => 'int', 'templates_left' => 'int', 'sms_verifications_left' => 'int', - 'num_fax_pages_left' => 'int', + 'num_fax_pages_left' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'api_signature_requests_left' => null, 'documents_left' => null, 'templates_total' => null, 'templates_left' => null, 'sms_verifications_left' => null, - 'num_fax_pages_left' => null, + 'num_fax_pages_left' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'api_signature_requests_left' => true, 'documents_left' => true, 'templates_total' => true, 'templates_left' => true, 'sms_verifications_left' => true, - 'num_fax_pages_left' => true, + 'num_fax_pages_left' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -124,6 +126,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -133,7 +137,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -143,7 +147,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -152,6 +156,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -160,6 +167,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -178,7 +188,7 @@ public function isNullableSetToNull(string $property): bool 'templates_total' => 'templates_total', 'templates_left' => 'templates_left', 'sms_verifications_left' => 'sms_verifications_left', - 'num_fax_pages_left' => 'num_fax_pages_left', + 'num_fax_pages_left' => 'num_fax_pages_left' ]; /** @@ -192,7 +202,7 @@ public function isNullableSetToNull(string $property): bool 'templates_total' => 'setTemplatesTotal', 'templates_left' => 'setTemplatesLeft', 'sms_verifications_left' => 'setSmsVerificationsLeft', - 'num_fax_pages_left' => 'setNumFaxPagesLeft', + 'num_fax_pages_left' => 'setNumFaxPagesLeft' ]; /** @@ -206,7 +216,7 @@ public function isNullableSetToNull(string $property): bool 'templates_total' => 'getTemplatesTotal', 'templates_left' => 'getTemplatesLeft', 'sms_verifications_left' => 'getSmsVerificationsLeft', - 'num_fax_pages_left' => 'getNumFaxPagesLeft', + 'num_fax_pages_left' => 'getNumFaxPagesLeft' ]; /** @@ -250,6 +260,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -273,33 +284,34 @@ public function __construct(array $data = null) $this->setIfExists('num_fax_pages_left', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): AccountResponseQuotas { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): AccountResponseQuotas { /** @var AccountResponseQuotas */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, AccountResponseQuotas::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -316,7 +328,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -330,6 +344,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets api_signature_requests_left * @@ -343,18 +358,18 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int|null $api_signature_requests_left API signature requests remaining + * @param int|null $api_signature_requests_left API signature requests remaining. * * @return self */ - public function setApiSignatureRequestsLeft(?int $api_signature_requests_left) + public function setApiSignatureRequestsLeft($api_signature_requests_left) { if (is_null($api_signature_requests_left)) { array_push($this->openAPINullablesSetToNull, 'api_signature_requests_left'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('api_signature_requests_left', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -377,18 +392,18 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int|null $documents_left signature requests remaining + * @param int|null $documents_left Signature requests remaining. * * @return self */ - public function setDocumentsLeft(?int $documents_left) + public function setDocumentsLeft($documents_left) { if (is_null($documents_left)) { array_push($this->openAPINullablesSetToNull, 'documents_left'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('documents_left', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -411,18 +426,18 @@ public function getTemplatesTotal() /** * Sets templates_total * - * @param int|null $templates_total total API templates allowed + * @param int|null $templates_total Total API templates allowed. * * @return self */ - public function setTemplatesTotal(?int $templates_total) + public function setTemplatesTotal($templates_total) { if (is_null($templates_total)) { array_push($this->openAPINullablesSetToNull, 'templates_total'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('templates_total', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -445,18 +460,18 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int|null $templates_left API templates remaining + * @param int|null $templates_left API templates remaining. * * @return self */ - public function setTemplatesLeft(?int $templates_left) + public function setTemplatesLeft($templates_left) { if (is_null($templates_left)) { array_push($this->openAPINullablesSetToNull, 'templates_left'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('templates_left', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -479,18 +494,18 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int|null $sms_verifications_left SMS verifications remaining + * @param int|null $sms_verifications_left SMS verifications remaining. * * @return self */ - public function setSmsVerificationsLeft(?int $sms_verifications_left) + public function setSmsVerificationsLeft($sms_verifications_left) { if (is_null($sms_verifications_left)) { array_push($this->openAPINullablesSetToNull, 'sms_verifications_left'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('sms_verifications_left', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -517,14 +532,14 @@ public function getNumFaxPagesLeft() * * @return self */ - public function setNumFaxPagesLeft(?int $num_fax_pages_left) + public function setNumFaxPagesLeft($num_fax_pages_left) { if (is_null($num_fax_pages_left)) { array_push($this->openAPINullablesSetToNull, 'num_fax_pages_left'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('num_fax_pages_left', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -533,13 +548,14 @@ public function setNumFaxPagesLeft(?int $num_fax_pages_left) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -548,11 +564,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -563,8 +579,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -577,9 +595,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -587,15 +607,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -621,3 +641,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/AccountResponseUsage.php b/sdks/php/src/Model/AccountResponseUsage.php index 94eb509e7..4f2d93556 100644 --- a/sdks/php/src/Model/AccountResponseUsage.php +++ b/sdks/php/src/Model/AccountResponseUsage.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,64 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * AccountResponseUsage Class Doc Comment * * @category Class * @description Details concerning monthly usage - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountResponseUsage implements ModelInterface, ArrayAccess, JsonSerializable +class AccountResponseUsage implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountResponseUsage'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'fax_pages_sent' => 'int', + 'fax_pages_sent' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'fax_pages_sent' => null, + 'fax_pages_sent' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'fax_pages_sent' => true, + 'fax_pages_sent' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +168,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'fax_pages_sent' => 'fax_pages_sent', + 'fax_pages_sent' => 'fax_pages_sent' ]; /** @@ -167,7 +177,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'fax_pages_sent' => 'setFaxPagesSent', + 'fax_pages_sent' => 'setFaxPagesSent' ]; /** @@ -176,7 +186,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'fax_pages_sent' => 'getFaxPagesSent', + 'fax_pages_sent' => 'getFaxPagesSent' ]; /** @@ -220,6 +230,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('fax_pages_sent', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): AccountResponseUsage { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): AccountResponseUsage { /** @var AccountResponseUsage */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, AccountResponseUsage::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -295,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets fax_pages_sent * @@ -312,14 +327,14 @@ public function getFaxPagesSent() * * @return self */ - public function setFaxPagesSent(?int $fax_pages_sent) + public function setFaxPagesSent($fax_pages_sent) { if (is_null($fax_pages_sent)) { array_push($this->openAPINullablesSetToNull, 'fax_pages_sent'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('fax_pages_sent', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -328,13 +343,14 @@ public function setFaxPagesSent(?int $fax_pages_sent) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -343,11 +359,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -358,8 +374,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -372,9 +390,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -382,15 +402,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -416,3 +436,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/AccountUpdateRequest.php b/sdks/php/src/Model/AccountUpdateRequest.php index 34a65c498..7db624751 100644 --- a/sdks/php/src/Model/AccountUpdateRequest.php +++ b/sdks/php/src/Model/AccountUpdateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * AccountUpdateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class AccountUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountUpdateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'callback_url' => 'string', - 'locale' => 'string', + 'locale' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'callback_url' => null, - 'locale' => null, + 'locale' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account_id' => true, 'callback_url' => false, - 'locale' => false, + 'locale' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'account_id' => 'account_id', 'callback_url' => 'callback_url', - 'locale' => 'locale', + 'locale' => 'locale' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'account_id' => 'setAccountId', 'callback_url' => 'setCallbackUrl', - 'locale' => 'setLocale', + 'locale' => 'setLocale' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'account_id' => 'getAccountId', 'callback_url' => 'getCallbackUrl', - 'locale' => 'getLocale', + 'locale' => 'getLocale' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('locale', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): AccountUpdateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): AccountUpdateRequest { /** @var AccountUpdateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, AccountUpdateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -295,7 +306,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -309,6 +322,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account_id * @@ -326,14 +340,14 @@ public function getAccountId() * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { array_push($this->openAPINullablesSetToNull, 'account_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('account_id', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -356,14 +370,14 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url the URL that Dropbox Sign should POST events to + * @param string|null $callback_url The URL that Dropbox Sign should POST events to. * * @return self */ - public function setCallbackUrl(?string $callback_url) + public function setCallbackUrl($callback_url) { if (is_null($callback_url)) { - throw new InvalidArgumentException('non-nullable callback_url cannot be null'); + throw new \InvalidArgumentException('non-nullable callback_url cannot be null'); } $this->container['callback_url'] = $callback_url; @@ -387,22 +401,23 @@ public function getLocale() * * @return self */ - public function setLocale(?string $locale) + public function setLocale($locale) { if (is_null($locale)) { - throw new InvalidArgumentException('non-nullable locale cannot be null'); + throw new \InvalidArgumentException('non-nullable locale cannot be null'); } $this->container['locale'] = $locale; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -411,11 +426,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -426,8 +441,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -440,9 +457,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -450,15 +469,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -484,3 +503,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/AccountVerifyRequest.php b/sdks/php/src/Model/AccountVerifyRequest.php index d8731ea40..3ebd4ab79 100644 --- a/sdks/php/src/Model/AccountVerifyRequest.php +++ b/sdks/php/src/Model/AccountVerifyRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * AccountVerifyRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountVerifyRequest implements ModelInterface, ArrayAccess, JsonSerializable +class AccountVerifyRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountVerifyRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'email_address' => 'string', + 'email_address' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'email_address' => 'email', + 'email_address' => 'email' ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'email_address' => false, + 'email_address' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'email_address' => 'email_address', + 'email_address' => 'email_address' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'email_address' => 'setEmailAddress', + 'email_address' => 'setEmailAddress' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'email_address' => 'getEmailAddress', + 'email_address' => 'getEmailAddress' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): AccountVerifyRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): AccountVerifyRequest { /** @var AccountVerifyRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, AccountVerifyRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,6 +311,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets email_address * @@ -313,26 +325,27 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address email address to run the verification for + * @param string $email_address Email address to run the verification for. * * @return self */ - public function setEmailAddress(string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -341,11 +354,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -356,8 +369,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -370,9 +385,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -380,15 +397,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -414,3 +431,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/AccountVerifyResponse.php b/sdks/php/src/Model/AccountVerifyResponse.php index f8f6a65e5..9a3663463 100644 --- a/sdks/php/src/Model/AccountVerifyResponse.php +++ b/sdks/php/src/Model/AccountVerifyResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * AccountVerifyResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountVerifyResponse implements ModelInterface, ArrayAccess, JsonSerializable +class AccountVerifyResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountVerifyResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account' => '\Dropbox\Sign\Model\AccountVerifyResponseAccount', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account' => 'account', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account' => 'setAccount', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account' => 'getAccount', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): AccountVerifyResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): AccountVerifyResponse { /** @var AccountVerifyResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, AccountVerifyResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -288,7 +299,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -302,10 +315,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account * - * @return AccountVerifyResponseAccount|null + * @return \Dropbox\Sign\Model\AccountVerifyResponseAccount|null */ public function getAccount() { @@ -315,14 +329,14 @@ public function getAccount() /** * Sets account * - * @param AccountVerifyResponseAccount|null $account account + * @param \Dropbox\Sign\Model\AccountVerifyResponseAccount|null $account account * * @return self */ - public function setAccount(?AccountVerifyResponseAccount $account) + public function setAccount($account) { if (is_null($account)) { - throw new InvalidArgumentException('non-nullable account cannot be null'); + throw new \InvalidArgumentException('non-nullable account cannot be null'); } $this->container['account'] = $account; @@ -332,7 +346,7 @@ public function setAccount(?AccountVerifyResponseAccount $account) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -342,26 +356,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -370,11 +385,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -385,8 +400,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -399,9 +416,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -409,15 +428,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -443,3 +462,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/AccountVerifyResponseAccount.php b/sdks/php/src/Model/AccountVerifyResponseAccount.php index 34a1de5e9..70749476b 100644 --- a/sdks/php/src/Model/AccountVerifyResponseAccount.php +++ b/sdks/php/src/Model/AccountVerifyResponseAccount.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * AccountVerifyResponseAccount Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountVerifyResponseAccount implements ModelInterface, ArrayAccess, JsonSerializable +class AccountVerifyResponseAccount implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountVerifyResponseAccount'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'email_address' => 'string', + 'email_address' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'email_address' => null, + 'email_address' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'email_address' => false, + 'email_address' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'email_address' => 'email_address', + 'email_address' => 'email_address' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'email_address' => 'setEmailAddress', + 'email_address' => 'setEmailAddress' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'email_address' => 'getEmailAddress', + 'email_address' => 'getEmailAddress' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): AccountVerifyResponseAccount { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): AccountVerifyResponseAccount { /** @var AccountVerifyResponseAccount */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, AccountVerifyResponseAccount::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +292,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -295,6 +308,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets email_address * @@ -308,26 +322,27 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address the email address associated with the Account + * @param string|null $email_address The email address associated with the Account. * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -336,11 +351,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -351,8 +366,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -365,9 +382,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -375,15 +394,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -409,3 +428,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ApiAppCreateRequest.php b/sdks/php/src/Model/ApiAppCreateRequest.php index d31444091..65521c6e8 100644 --- a/sdks/php/src/Model/ApiAppCreateRequest.php +++ b/sdks/php/src/Model/ApiAppCreateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ApiAppCreateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class ApiAppCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'domains' => 'string[]', 'name' => 'string', @@ -64,16 +64,16 @@ class ApiAppCreateRequest implements ModelInterface, ArrayAccess, JsonSerializab 'custom_logo_file' => '\SplFileObject', 'oauth' => '\Dropbox\Sign\Model\SubOAuth', 'options' => '\Dropbox\Sign\Model\SubOptions', - 'white_labeling_options' => '\Dropbox\Sign\Model\SubWhiteLabelingOptions', + 'white_labeling_options' => '\Dropbox\Sign\Model\SubWhiteLabelingOptions' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'domains' => null, 'name' => null, @@ -81,14 +81,14 @@ class ApiAppCreateRequest implements ModelInterface, ArrayAccess, JsonSerializab 'custom_logo_file' => 'binary', 'oauth' => null, 'options' => null, - 'white_labeling_options' => null, + 'white_labeling_options' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'domains' => false, 'name' => false, @@ -96,14 +96,14 @@ class ApiAppCreateRequest implements ModelInterface, ArrayAccess, JsonSerializab 'custom_logo_file' => false, 'oauth' => false, 'options' => false, - 'white_labeling_options' => false, + 'white_labeling_options' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -128,6 +128,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -137,7 +139,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -147,7 +149,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -156,6 +158,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -164,6 +169,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -183,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'custom_logo_file' => 'custom_logo_file', 'oauth' => 'oauth', 'options' => 'options', - 'white_labeling_options' => 'white_labeling_options', + 'white_labeling_options' => 'white_labeling_options' ]; /** @@ -198,7 +206,7 @@ public function isNullableSetToNull(string $property): bool 'custom_logo_file' => 'setCustomLogoFile', 'oauth' => 'setOauth', 'options' => 'setOptions', - 'white_labeling_options' => 'setWhiteLabelingOptions', + 'white_labeling_options' => 'setWhiteLabelingOptions' ]; /** @@ -213,7 +221,7 @@ public function isNullableSetToNull(string $property): bool 'custom_logo_file' => 'getCustomLogoFile', 'oauth' => 'getOauth', 'options' => 'getOptions', - 'white_labeling_options' => 'getWhiteLabelingOptions', + 'white_labeling_options' => 'getWhiteLabelingOptions' ]; /** @@ -257,6 +265,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -281,33 +290,34 @@ public function __construct(array $data = null) $this->setIfExists('white_labeling_options', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ApiAppCreateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ApiAppCreateRequest { /** @var ApiAppCreateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ApiAppCreateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -329,11 +339,11 @@ public function listInvalidProperties() if ($this->container['domains'] === null) { $invalidProperties[] = "'domains' can't be null"; } - if (count($this->container['domains']) > 2) { + if ((count($this->container['domains']) > 2)) { $invalidProperties[] = "invalid value for 'domains', number of items must be less than or equal to 2."; } - if (count($this->container['domains']) < 1) { + if ((count($this->container['domains']) < 1)) { $invalidProperties[] = "invalid value for 'domains', number of items must be greater than or equal to 1."; } @@ -354,6 +364,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets domains * @@ -367,21 +378,21 @@ public function getDomains() /** * Sets domains * - * @param string[] $domains the domain names the ApiApp will be associated with + * @param string[] $domains The domain names the ApiApp will be associated with. * * @return self */ - public function setDomains(array $domains) + public function setDomains($domains) { if (is_null($domains)) { - throw new InvalidArgumentException('non-nullable domains cannot be null'); + throw new \InvalidArgumentException('non-nullable domains cannot be null'); } - if (count($domains) > 2) { - throw new InvalidArgumentException('invalid value for $domains when calling ApiAppCreateRequest., number of items must be less than or equal to 2.'); + if ((count($domains) > 2)) { + throw new \InvalidArgumentException('invalid value for $domains when calling ApiAppCreateRequest., number of items must be less than or equal to 2.'); } - if (count($domains) < 1) { - throw new InvalidArgumentException('invalid length for $domains when calling ApiAppCreateRequest., number of items must be greater than or equal to 1.'); + if ((count($domains) < 1)) { + throw new \InvalidArgumentException('invalid length for $domains when calling ApiAppCreateRequest., number of items must be greater than or equal to 1.'); } $this->container['domains'] = $domains; @@ -401,14 +412,14 @@ public function getName() /** * Sets name * - * @param string $name the name you want to assign to the ApiApp + * @param string $name The name you want to assign to the ApiApp. * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -428,14 +439,14 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url the URL at which the ApiApp should receive event callbacks + * @param string|null $callback_url The URL at which the ApiApp should receive event callbacks. * * @return self */ - public function setCallbackUrl(?string $callback_url) + public function setCallbackUrl($callback_url) { if (is_null($callback_url)) { - throw new InvalidArgumentException('non-nullable callback_url cannot be null'); + throw new \InvalidArgumentException('non-nullable callback_url cannot be null'); } $this->container['callback_url'] = $callback_url; @@ -445,7 +456,7 @@ public function setCallbackUrl(?string $callback_url) /** * Gets custom_logo_file * - * @return SplFileObject|null + * @return \SplFileObject|null */ public function getCustomLogoFile() { @@ -455,14 +466,14 @@ public function getCustomLogoFile() /** * Sets custom_logo_file * - * @param SplFileObject|null $custom_logo_file An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) + * @param \SplFileObject|null $custom_logo_file An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) * * @return self */ - public function setCustomLogoFile(?SplFileObject $custom_logo_file) + public function setCustomLogoFile($custom_logo_file) { if (is_null($custom_logo_file)) { - throw new InvalidArgumentException('non-nullable custom_logo_file cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_logo_file cannot be null'); } $this->container['custom_logo_file'] = $custom_logo_file; @@ -472,7 +483,7 @@ public function setCustomLogoFile(?SplFileObject $custom_logo_file) /** * Gets oauth * - * @return SubOAuth|null + * @return \Dropbox\Sign\Model\SubOAuth|null */ public function getOauth() { @@ -482,14 +493,14 @@ public function getOauth() /** * Sets oauth * - * @param SubOAuth|null $oauth oauth + * @param \Dropbox\Sign\Model\SubOAuth|null $oauth oauth * * @return self */ - public function setOauth(?SubOAuth $oauth) + public function setOauth($oauth) { if (is_null($oauth)) { - throw new InvalidArgumentException('non-nullable oauth cannot be null'); + throw new \InvalidArgumentException('non-nullable oauth cannot be null'); } $this->container['oauth'] = $oauth; @@ -499,7 +510,7 @@ public function setOauth(?SubOAuth $oauth) /** * Gets options * - * @return SubOptions|null + * @return \Dropbox\Sign\Model\SubOptions|null */ public function getOptions() { @@ -509,14 +520,14 @@ public function getOptions() /** * Sets options * - * @param SubOptions|null $options options + * @param \Dropbox\Sign\Model\SubOptions|null $options options * * @return self */ - public function setOptions(?SubOptions $options) + public function setOptions($options) { if (is_null($options)) { - throw new InvalidArgumentException('non-nullable options cannot be null'); + throw new \InvalidArgumentException('non-nullable options cannot be null'); } $this->container['options'] = $options; @@ -526,7 +537,7 @@ public function setOptions(?SubOptions $options) /** * Gets white_labeling_options * - * @return SubWhiteLabelingOptions|null + * @return \Dropbox\Sign\Model\SubWhiteLabelingOptions|null */ public function getWhiteLabelingOptions() { @@ -536,26 +547,27 @@ public function getWhiteLabelingOptions() /** * Sets white_labeling_options * - * @param SubWhiteLabelingOptions|null $white_labeling_options white_labeling_options + * @param \Dropbox\Sign\Model\SubWhiteLabelingOptions|null $white_labeling_options white_labeling_options * * @return self */ - public function setWhiteLabelingOptions(?SubWhiteLabelingOptions $white_labeling_options) + public function setWhiteLabelingOptions($white_labeling_options) { if (is_null($white_labeling_options)) { - throw new InvalidArgumentException('non-nullable white_labeling_options cannot be null'); + throw new \InvalidArgumentException('non-nullable white_labeling_options cannot be null'); } $this->container['white_labeling_options'] = $white_labeling_options; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -564,11 +576,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -579,8 +591,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -593,9 +607,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -603,15 +619,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -637,3 +653,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ApiAppGetResponse.php b/sdks/php/src/Model/ApiAppGetResponse.php index f95c2b6e0..35cda6354 100644 --- a/sdks/php/src/Model/ApiAppGetResponse.php +++ b/sdks/php/src/Model/ApiAppGetResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ApiAppGetResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppGetResponse implements ModelInterface, ArrayAccess, JsonSerializable +class ApiAppGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'api_app' => '\Dropbox\Sign\Model\ApiAppResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'api_app' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'api_app' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'api_app' => 'api_app', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'api_app' => 'setApiApp', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'api_app' => 'getApiApp', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ApiAppGetResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ApiAppGetResponse { /** @var ApiAppGetResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ApiAppGetResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets api_app * - * @return ApiAppResponse + * @return \Dropbox\Sign\Model\ApiAppResponse */ public function getApiApp() { @@ -320,14 +332,14 @@ public function getApiApp() /** * Sets api_app * - * @param ApiAppResponse $api_app api_app + * @param \Dropbox\Sign\Model\ApiAppResponse $api_app api_app * * @return self */ - public function setApiApp(ApiAppResponse $api_app) + public function setApiApp($api_app) { if (is_null($api_app)) { - throw new InvalidArgumentException('non-nullable api_app cannot be null'); + throw new \InvalidArgumentException('non-nullable api_app cannot be null'); } $this->container['api_app'] = $api_app; @@ -337,7 +349,7 @@ public function setApiApp(ApiAppResponse $api_app) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ApiAppListResponse.php b/sdks/php/src/Model/ApiAppListResponse.php index 44afca3c1..bbc9dd238 100644 --- a/sdks/php/src/Model/ApiAppListResponse.php +++ b/sdks/php/src/Model/ApiAppListResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ApiAppListResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppListResponse implements ModelInterface, ArrayAccess, JsonSerializable +class ApiAppListResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'api_apps' => '\Dropbox\Sign\Model\ApiAppResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'api_apps' => null, 'list_info' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'api_apps' => false, 'list_info' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'api_apps' => 'api_apps', 'list_info' => 'list_info', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'api_apps' => 'setApiApps', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'api_apps' => 'getApiApps', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ApiAppListResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ApiAppListResponse { /** @var ApiAppListResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ApiAppListResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,10 +328,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets api_apps * - * @return ApiAppResponse[] + * @return \Dropbox\Sign\Model\ApiAppResponse[] */ public function getApiApps() { @@ -330,14 +342,14 @@ public function getApiApps() /** * Sets api_apps * - * @param ApiAppResponse[] $api_apps contains information about API Apps + * @param \Dropbox\Sign\Model\ApiAppResponse[] $api_apps Contains information about API Apps. * * @return self */ - public function setApiApps(array $api_apps) + public function setApiApps($api_apps) { if (is_null($api_apps)) { - throw new InvalidArgumentException('non-nullable api_apps cannot be null'); + throw new \InvalidArgumentException('non-nullable api_apps cannot be null'); } $this->container['api_apps'] = $api_apps; @@ -347,7 +359,7 @@ public function setApiApps(array $api_apps) /** * Gets list_info * - * @return ListInfoResponse + * @return \Dropbox\Sign\Model\ListInfoResponse */ public function getListInfo() { @@ -357,14 +369,14 @@ public function getListInfo() /** * Sets list_info * - * @param ListInfoResponse $list_info list_info + * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo(ListInfoResponse $list_info) + public function setListInfo($list_info) { if (is_null($list_info)) { - throw new InvalidArgumentException('non-nullable list_info cannot be null'); + throw new \InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -374,7 +386,7 @@ public function setListInfo(ListInfoResponse $list_info) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -384,26 +396,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -412,11 +425,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -427,8 +440,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -441,9 +456,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -451,15 +468,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -485,3 +502,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ApiAppResponse.php b/sdks/php/src/Model/ApiAppResponse.php index 3e214031d..d62f18ec1 100644 --- a/sdks/php/src/Model/ApiAppResponse.php +++ b/sdks/php/src/Model/ApiAppResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ApiAppResponse Class Doc Comment * * @category Class * @description Contains information about an API App. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable +class ApiAppResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'callback_url' => 'string', 'client_id' => 'string', @@ -67,16 +68,16 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable 'oauth' => '\Dropbox\Sign\Model\ApiAppResponseOAuth', 'options' => '\Dropbox\Sign\Model\ApiAppResponseOptions', 'owner_account' => '\Dropbox\Sign\Model\ApiAppResponseOwnerAccount', - 'white_labeling_options' => '\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions', + 'white_labeling_options' => '\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'callback_url' => null, 'client_id' => null, @@ -87,14 +88,14 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable 'oauth' => null, 'options' => null, 'owner_account' => null, - 'white_labeling_options' => null, + 'white_labeling_options' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'callback_url' => true, 'client_id' => false, @@ -105,14 +106,14 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable 'oauth' => true, 'options' => true, 'owner_account' => false, - 'white_labeling_options' => true, + 'white_labeling_options' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -137,6 +138,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -146,7 +149,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -156,7 +159,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -165,6 +168,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -173,6 +179,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'oauth' => 'oauth', 'options' => 'options', 'owner_account' => 'owner_account', - 'white_labeling_options' => 'white_labeling_options', + 'white_labeling_options' => 'white_labeling_options' ]; /** @@ -213,7 +222,7 @@ public function isNullableSetToNull(string $property): bool 'oauth' => 'setOauth', 'options' => 'setOptions', 'owner_account' => 'setOwnerAccount', - 'white_labeling_options' => 'setWhiteLabelingOptions', + 'white_labeling_options' => 'setWhiteLabelingOptions' ]; /** @@ -231,7 +240,7 @@ public function isNullableSetToNull(string $property): bool 'oauth' => 'getOauth', 'options' => 'getOptions', 'owner_account' => 'getOwnerAccount', - 'white_labeling_options' => 'getWhiteLabelingOptions', + 'white_labeling_options' => 'getWhiteLabelingOptions' ]; /** @@ -275,6 +284,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -302,33 +312,34 @@ public function __construct(array $data = null) $this->setIfExists('white_labeling_options', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ApiAppResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ApiAppResponse { /** @var ApiAppResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ApiAppResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -345,7 +356,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -359,6 +372,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets callback_url * @@ -376,14 +390,14 @@ public function getCallbackUrl() * * @return self */ - public function setCallbackUrl(?string $callback_url) + public function setCallbackUrl($callback_url) { if (is_null($callback_url)) { array_push($this->openAPINullablesSetToNull, 'callback_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('callback_url', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -410,10 +424,10 @@ public function getClientId() * * @return self */ - public function setClientId(?string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -437,10 +451,10 @@ public function getCreatedAt() * * @return self */ - public function setCreatedAt(?int $created_at) + public function setCreatedAt($created_at) { if (is_null($created_at)) { - throw new InvalidArgumentException('non-nullable created_at cannot be null'); + throw new \InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; @@ -464,10 +478,10 @@ public function getDomains() * * @return self */ - public function setDomains(?array $domains) + public function setDomains($domains) { if (is_null($domains)) { - throw new InvalidArgumentException('non-nullable domains cannot be null'); + throw new \InvalidArgumentException('non-nullable domains cannot be null'); } $this->container['domains'] = $domains; @@ -491,10 +505,10 @@ public function getName() * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -518,10 +532,10 @@ public function getIsApproved() * * @return self */ - public function setIsApproved(?bool $is_approved) + public function setIsApproved($is_approved) { if (is_null($is_approved)) { - throw new InvalidArgumentException('non-nullable is_approved cannot be null'); + throw new \InvalidArgumentException('non-nullable is_approved cannot be null'); } $this->container['is_approved'] = $is_approved; @@ -531,7 +545,7 @@ public function setIsApproved(?bool $is_approved) /** * Gets oauth * - * @return ApiAppResponseOAuth|null + * @return \Dropbox\Sign\Model\ApiAppResponseOAuth|null */ public function getOauth() { @@ -541,18 +555,18 @@ public function getOauth() /** * Sets oauth * - * @param ApiAppResponseOAuth|null $oauth oauth + * @param \Dropbox\Sign\Model\ApiAppResponseOAuth|null $oauth oauth * * @return self */ - public function setOauth(?ApiAppResponseOAuth $oauth) + public function setOauth($oauth) { if (is_null($oauth)) { array_push($this->openAPINullablesSetToNull, 'oauth'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('oauth', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -565,7 +579,7 @@ public function setOauth(?ApiAppResponseOAuth $oauth) /** * Gets options * - * @return ApiAppResponseOptions|null + * @return \Dropbox\Sign\Model\ApiAppResponseOptions|null */ public function getOptions() { @@ -575,18 +589,18 @@ public function getOptions() /** * Sets options * - * @param ApiAppResponseOptions|null $options options + * @param \Dropbox\Sign\Model\ApiAppResponseOptions|null $options options * * @return self */ - public function setOptions(?ApiAppResponseOptions $options) + public function setOptions($options) { if (is_null($options)) { array_push($this->openAPINullablesSetToNull, 'options'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('options', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -599,7 +613,7 @@ public function setOptions(?ApiAppResponseOptions $options) /** * Gets owner_account * - * @return ApiAppResponseOwnerAccount|null + * @return \Dropbox\Sign\Model\ApiAppResponseOwnerAccount|null */ public function getOwnerAccount() { @@ -609,14 +623,14 @@ public function getOwnerAccount() /** * Sets owner_account * - * @param ApiAppResponseOwnerAccount|null $owner_account owner_account + * @param \Dropbox\Sign\Model\ApiAppResponseOwnerAccount|null $owner_account owner_account * * @return self */ - public function setOwnerAccount(?ApiAppResponseOwnerAccount $owner_account) + public function setOwnerAccount($owner_account) { if (is_null($owner_account)) { - throw new InvalidArgumentException('non-nullable owner_account cannot be null'); + throw new \InvalidArgumentException('non-nullable owner_account cannot be null'); } $this->container['owner_account'] = $owner_account; @@ -626,7 +640,7 @@ public function setOwnerAccount(?ApiAppResponseOwnerAccount $owner_account) /** * Gets white_labeling_options * - * @return ApiAppResponseWhiteLabelingOptions|null + * @return \Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions|null */ public function getWhiteLabelingOptions() { @@ -636,18 +650,18 @@ public function getWhiteLabelingOptions() /** * Sets white_labeling_options * - * @param ApiAppResponseWhiteLabelingOptions|null $white_labeling_options white_labeling_options + * @param \Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions|null $white_labeling_options white_labeling_options * * @return self */ - public function setWhiteLabelingOptions(?ApiAppResponseWhiteLabelingOptions $white_labeling_options) + public function setWhiteLabelingOptions($white_labeling_options) { if (is_null($white_labeling_options)) { array_push($this->openAPINullablesSetToNull, 'white_labeling_options'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('white_labeling_options', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -656,13 +670,14 @@ public function setWhiteLabelingOptions(?ApiAppResponseWhiteLabelingOptions $whi return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -671,11 +686,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -686,8 +701,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -700,9 +717,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -710,15 +729,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -744,3 +763,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ApiAppResponseOAuth.php b/sdks/php/src/Model/ApiAppResponseOAuth.php index ac2ecf08b..0b99d7575 100644 --- a/sdks/php/src/Model/ApiAppResponseOAuth.php +++ b/sdks/php/src/Model/ApiAppResponseOAuth.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,74 +29,73 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ApiAppResponseOAuth Class Doc Comment * * @category Class * @description An object describing the app's OAuth properties, or null if OAuth is not configured for the app. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppResponseOAuth implements ModelInterface, ArrayAccess, JsonSerializable +class ApiAppResponseOAuth implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppResponseOAuth'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'callback_url' => 'string', 'secret' => 'string', 'scopes' => 'string[]', - 'charges_users' => 'bool', + 'charges_users' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'callback_url' => null, 'secret' => null, 'scopes' => null, - 'charges_users' => null, + 'charges_users' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'callback_url' => false, 'secret' => true, 'scopes' => false, - 'charges_users' => false, + 'charges_users' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,6 +120,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -128,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -138,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -147,6 +150,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -155,6 +161,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool 'callback_url' => 'callback_url', 'secret' => 'secret', 'scopes' => 'scopes', - 'charges_users' => 'charges_users', + 'charges_users' => 'charges_users' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'callback_url' => 'setCallbackUrl', 'secret' => 'setSecret', 'scopes' => 'setScopes', - 'charges_users' => 'setChargesUsers', + 'charges_users' => 'setChargesUsers' ]; /** @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'callback_url' => 'getCallbackUrl', 'secret' => 'getSecret', 'scopes' => 'getScopes', - 'charges_users' => 'getChargesUsers', + 'charges_users' => 'getChargesUsers' ]; /** @@ -239,6 +248,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -260,33 +270,34 @@ public function __construct(array $data = null) $this->setIfExists('charges_users', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ApiAppResponseOAuth { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ApiAppResponseOAuth { /** @var ApiAppResponseOAuth */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ApiAppResponseOAuth::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -303,7 +314,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -317,6 +330,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets callback_url * @@ -330,14 +344,14 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url the app's OAuth callback URL + * @param string|null $callback_url The app's OAuth callback URL. * * @return self */ - public function setCallbackUrl(?string $callback_url) + public function setCallbackUrl($callback_url) { if (is_null($callback_url)) { - throw new InvalidArgumentException('non-nullable callback_url cannot be null'); + throw new \InvalidArgumentException('non-nullable callback_url cannot be null'); } $this->container['callback_url'] = $callback_url; @@ -357,18 +371,18 @@ public function getSecret() /** * Sets secret * - * @param string|null $secret the app's OAuth secret, or null if the app does not belong to user + * @param string|null $secret The app's OAuth secret, or null if the app does not belong to user. * * @return self */ - public function setSecret(?string $secret) + public function setSecret($secret) { if (is_null($secret)) { array_push($this->openAPINullablesSetToNull, 'secret'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('secret', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -391,14 +405,14 @@ public function getScopes() /** * Sets scopes * - * @param string[]|null $scopes array of OAuth scopes used by the app + * @param string[]|null $scopes Array of OAuth scopes used by the app. * * @return self */ - public function setScopes(?array $scopes) + public function setScopes($scopes) { if (is_null($scopes)) { - throw new InvalidArgumentException('non-nullable scopes cannot be null'); + throw new \InvalidArgumentException('non-nullable scopes cannot be null'); } $this->container['scopes'] = $scopes; @@ -418,26 +432,27 @@ public function getChargesUsers() /** * Sets charges_users * - * @param bool|null $charges_users boolean indicating whether the app owner or the account granting permission is billed for OAuth requests + * @param bool|null $charges_users Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. * * @return self */ - public function setChargesUsers(?bool $charges_users) + public function setChargesUsers($charges_users) { if (is_null($charges_users)) { - throw new InvalidArgumentException('non-nullable charges_users cannot be null'); + throw new \InvalidArgumentException('non-nullable charges_users cannot be null'); } $this->container['charges_users'] = $charges_users; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -446,11 +461,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -461,8 +476,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -475,9 +492,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -485,15 +504,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -519,3 +538,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ApiAppResponseOptions.php b/sdks/php/src/Model/ApiAppResponseOptions.php index 99c11f02a..69c935fdd 100644 --- a/sdks/php/src/Model/ApiAppResponseOptions.php +++ b/sdks/php/src/Model/ApiAppResponseOptions.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,65 +29,64 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ApiAppResponseOptions Class Doc Comment * * @category Class * @description An object with options that override account settings. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppResponseOptions implements ModelInterface, ArrayAccess, JsonSerializable +class ApiAppResponseOptions implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppResponseOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'can_insert_everywhere' => 'bool', + 'can_insert_everywhere' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'can_insert_everywhere' => null, + 'can_insert_everywhere' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'can_insert_everywhere' => false, + 'can_insert_everywhere' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -159,7 +168,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'can_insert_everywhere' => 'can_insert_everywhere', + 'can_insert_everywhere' => 'can_insert_everywhere' ]; /** @@ -168,7 +177,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'can_insert_everywhere' => 'setCanInsertEverywhere', + 'can_insert_everywhere' => 'setCanInsertEverywhere' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'can_insert_everywhere' => 'getCanInsertEverywhere', + 'can_insert_everywhere' => 'getCanInsertEverywhere' ]; /** @@ -221,6 +230,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -239,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('can_insert_everywhere', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ApiAppResponseOptions { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ApiAppResponseOptions { /** @var ApiAppResponseOptions */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ApiAppResponseOptions::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -282,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -296,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets can_insert_everywhere * @@ -313,22 +327,23 @@ public function getCanInsertEverywhere() * * @return self */ - public function setCanInsertEverywhere(?bool $can_insert_everywhere) + public function setCanInsertEverywhere($can_insert_everywhere) { if (is_null($can_insert_everywhere)) { - throw new InvalidArgumentException('non-nullable can_insert_everywhere cannot be null'); + throw new \InvalidArgumentException('non-nullable can_insert_everywhere cannot be null'); } $this->container['can_insert_everywhere'] = $can_insert_everywhere; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -337,11 +352,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -352,8 +367,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -366,9 +383,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -376,15 +395,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -410,3 +429,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ApiAppResponseOwnerAccount.php b/sdks/php/src/Model/ApiAppResponseOwnerAccount.php index ffc120960..ef2870757 100644 --- a/sdks/php/src/Model/ApiAppResponseOwnerAccount.php +++ b/sdks/php/src/Model/ApiAppResponseOwnerAccount.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,68 +29,67 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ApiAppResponseOwnerAccount Class Doc Comment * * @category Class * @description An object describing the app's owner - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppResponseOwnerAccount implements ModelInterface, ArrayAccess, JsonSerializable +class ApiAppResponseOwnerAccount implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppResponseOwnerAccount'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', - 'email_address' => 'string', + 'email_address' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, - 'email_address' => null, + 'email_address' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account_id' => false, - 'email_address' => false, + 'email_address' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -163,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account_id' => 'account_id', - 'email_address' => 'email_address', + 'email_address' => 'email_address' ]; /** @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account_id' => 'setAccountId', - 'email_address' => 'setEmailAddress', + 'email_address' => 'setEmailAddress' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account_id' => 'getAccountId', - 'email_address' => 'getEmailAddress', + 'email_address' => 'getEmailAddress' ]; /** @@ -227,6 +236,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -246,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ApiAppResponseOwnerAccount { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ApiAppResponseOwnerAccount { /** @var ApiAppResponseOwnerAccount */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ApiAppResponseOwnerAccount::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -289,7 +300,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -303,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account_id * @@ -320,10 +334,10 @@ public function getAccountId() * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -347,22 +361,23 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -371,11 +386,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -386,8 +401,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -400,9 +417,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -410,15 +429,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -444,3 +463,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php b/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php index 95f29f5f4..5626d2248 100644 --- a/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php +++ b/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ApiAppResponseWhiteLabelingOptions Class Doc Comment * * @category Class * @description An object with options to customize the app's signer page - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppResponseWhiteLabelingOptions implements ModelInterface, ArrayAccess, JsonSerializable +class ApiAppResponseWhiteLabelingOptions implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppResponseWhiteLabelingOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'header_background_color' => 'string', 'legal_version' => 'string', @@ -71,16 +72,16 @@ class ApiAppResponseWhiteLabelingOptions implements ModelInterface, ArrayAccess, 'secondary_button_text_color' => 'string', 'secondary_button_text_color_hover' => 'string', 'text_color1' => 'string', - 'text_color2' => 'string', + 'text_color2' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'header_background_color' => null, 'legal_version' => null, @@ -95,14 +96,14 @@ class ApiAppResponseWhiteLabelingOptions implements ModelInterface, ArrayAccess, 'secondary_button_text_color' => null, 'secondary_button_text_color_hover' => null, 'text_color1' => null, - 'text_color2' => null, + 'text_color2' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'header_background_color' => false, 'legal_version' => false, @@ -117,14 +118,14 @@ class ApiAppResponseWhiteLabelingOptions implements ModelInterface, ArrayAccess, 'secondary_button_text_color' => false, 'secondary_button_text_color_hover' => false, 'text_color1' => false, - 'text_color2' => false, + 'text_color2' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -149,6 +150,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -158,7 +161,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -168,7 +171,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -177,6 +180,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -185,6 +191,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -211,7 +220,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color' => 'secondary_button_text_color', 'secondary_button_text_color_hover' => 'secondary_button_text_color_hover', 'text_color1' => 'text_color1', - 'text_color2' => 'text_color2', + 'text_color2' => 'text_color2' ]; /** @@ -233,7 +242,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color' => 'setSecondaryButtonTextColor', 'secondary_button_text_color_hover' => 'setSecondaryButtonTextColorHover', 'text_color1' => 'setTextColor1', - 'text_color2' => 'setTextColor2', + 'text_color2' => 'setTextColor2' ]; /** @@ -255,7 +264,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color' => 'getSecondaryButtonTextColor', 'secondary_button_text_color_hover' => 'getSecondaryButtonTextColorHover', 'text_color1' => 'getTextColor1', - 'text_color2' => 'getTextColor2', + 'text_color2' => 'getTextColor2' ]; /** @@ -299,6 +308,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -330,33 +340,34 @@ public function __construct(array $data = null) $this->setIfExists('text_color2', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ApiAppResponseWhiteLabelingOptions { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ApiAppResponseWhiteLabelingOptions { /** @var ApiAppResponseWhiteLabelingOptions */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ApiAppResponseWhiteLabelingOptions::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -373,7 +384,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -387,6 +400,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets header_background_color * @@ -404,10 +418,10 @@ public function getHeaderBackgroundColor() * * @return self */ - public function setHeaderBackgroundColor(?string $header_background_color) + public function setHeaderBackgroundColor($header_background_color) { if (is_null($header_background_color)) { - throw new InvalidArgumentException('non-nullable header_background_color cannot be null'); + throw new \InvalidArgumentException('non-nullable header_background_color cannot be null'); } $this->container['header_background_color'] = $header_background_color; @@ -431,10 +445,10 @@ public function getLegalVersion() * * @return self */ - public function setLegalVersion(?string $legal_version) + public function setLegalVersion($legal_version) { if (is_null($legal_version)) { - throw new InvalidArgumentException('non-nullable legal_version cannot be null'); + throw new \InvalidArgumentException('non-nullable legal_version cannot be null'); } $this->container['legal_version'] = $legal_version; @@ -458,10 +472,10 @@ public function getLinkColor() * * @return self */ - public function setLinkColor(?string $link_color) + public function setLinkColor($link_color) { if (is_null($link_color)) { - throw new InvalidArgumentException('non-nullable link_color cannot be null'); + throw new \InvalidArgumentException('non-nullable link_color cannot be null'); } $this->container['link_color'] = $link_color; @@ -485,10 +499,10 @@ public function getPageBackgroundColor() * * @return self */ - public function setPageBackgroundColor(?string $page_background_color) + public function setPageBackgroundColor($page_background_color) { if (is_null($page_background_color)) { - throw new InvalidArgumentException('non-nullable page_background_color cannot be null'); + throw new \InvalidArgumentException('non-nullable page_background_color cannot be null'); } $this->container['page_background_color'] = $page_background_color; @@ -512,10 +526,10 @@ public function getPrimaryButtonColor() * * @return self */ - public function setPrimaryButtonColor(?string $primary_button_color) + public function setPrimaryButtonColor($primary_button_color) { if (is_null($primary_button_color)) { - throw new InvalidArgumentException('non-nullable primary_button_color cannot be null'); + throw new \InvalidArgumentException('non-nullable primary_button_color cannot be null'); } $this->container['primary_button_color'] = $primary_button_color; @@ -539,10 +553,10 @@ public function getPrimaryButtonColorHover() * * @return self */ - public function setPrimaryButtonColorHover(?string $primary_button_color_hover) + public function setPrimaryButtonColorHover($primary_button_color_hover) { if (is_null($primary_button_color_hover)) { - throw new InvalidArgumentException('non-nullable primary_button_color_hover cannot be null'); + throw new \InvalidArgumentException('non-nullable primary_button_color_hover cannot be null'); } $this->container['primary_button_color_hover'] = $primary_button_color_hover; @@ -566,10 +580,10 @@ public function getPrimaryButtonTextColor() * * @return self */ - public function setPrimaryButtonTextColor(?string $primary_button_text_color) + public function setPrimaryButtonTextColor($primary_button_text_color) { if (is_null($primary_button_text_color)) { - throw new InvalidArgumentException('non-nullable primary_button_text_color cannot be null'); + throw new \InvalidArgumentException('non-nullable primary_button_text_color cannot be null'); } $this->container['primary_button_text_color'] = $primary_button_text_color; @@ -593,10 +607,10 @@ public function getPrimaryButtonTextColorHover() * * @return self */ - public function setPrimaryButtonTextColorHover(?string $primary_button_text_color_hover) + public function setPrimaryButtonTextColorHover($primary_button_text_color_hover) { if (is_null($primary_button_text_color_hover)) { - throw new InvalidArgumentException('non-nullable primary_button_text_color_hover cannot be null'); + throw new \InvalidArgumentException('non-nullable primary_button_text_color_hover cannot be null'); } $this->container['primary_button_text_color_hover'] = $primary_button_text_color_hover; @@ -620,10 +634,10 @@ public function getSecondaryButtonColor() * * @return self */ - public function setSecondaryButtonColor(?string $secondary_button_color) + public function setSecondaryButtonColor($secondary_button_color) { if (is_null($secondary_button_color)) { - throw new InvalidArgumentException('non-nullable secondary_button_color cannot be null'); + throw new \InvalidArgumentException('non-nullable secondary_button_color cannot be null'); } $this->container['secondary_button_color'] = $secondary_button_color; @@ -647,10 +661,10 @@ public function getSecondaryButtonColorHover() * * @return self */ - public function setSecondaryButtonColorHover(?string $secondary_button_color_hover) + public function setSecondaryButtonColorHover($secondary_button_color_hover) { if (is_null($secondary_button_color_hover)) { - throw new InvalidArgumentException('non-nullable secondary_button_color_hover cannot be null'); + throw new \InvalidArgumentException('non-nullable secondary_button_color_hover cannot be null'); } $this->container['secondary_button_color_hover'] = $secondary_button_color_hover; @@ -674,10 +688,10 @@ public function getSecondaryButtonTextColor() * * @return self */ - public function setSecondaryButtonTextColor(?string $secondary_button_text_color) + public function setSecondaryButtonTextColor($secondary_button_text_color) { if (is_null($secondary_button_text_color)) { - throw new InvalidArgumentException('non-nullable secondary_button_text_color cannot be null'); + throw new \InvalidArgumentException('non-nullable secondary_button_text_color cannot be null'); } $this->container['secondary_button_text_color'] = $secondary_button_text_color; @@ -701,10 +715,10 @@ public function getSecondaryButtonTextColorHover() * * @return self */ - public function setSecondaryButtonTextColorHover(?string $secondary_button_text_color_hover) + public function setSecondaryButtonTextColorHover($secondary_button_text_color_hover) { if (is_null($secondary_button_text_color_hover)) { - throw new InvalidArgumentException('non-nullable secondary_button_text_color_hover cannot be null'); + throw new \InvalidArgumentException('non-nullable secondary_button_text_color_hover cannot be null'); } $this->container['secondary_button_text_color_hover'] = $secondary_button_text_color_hover; @@ -728,10 +742,10 @@ public function getTextColor1() * * @return self */ - public function setTextColor1(?string $text_color1) + public function setTextColor1($text_color1) { if (is_null($text_color1)) { - throw new InvalidArgumentException('non-nullable text_color1 cannot be null'); + throw new \InvalidArgumentException('non-nullable text_color1 cannot be null'); } $this->container['text_color1'] = $text_color1; @@ -755,22 +769,23 @@ public function getTextColor2() * * @return self */ - public function setTextColor2(?string $text_color2) + public function setTextColor2($text_color2) { if (is_null($text_color2)) { - throw new InvalidArgumentException('non-nullable text_color2 cannot be null'); + throw new \InvalidArgumentException('non-nullable text_color2 cannot be null'); } $this->container['text_color2'] = $text_color2; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -779,11 +794,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -794,8 +809,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -808,9 +825,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -818,15 +837,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -852,3 +871,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ApiAppUpdateRequest.php b/sdks/php/src/Model/ApiAppUpdateRequest.php index 456d143c2..77339a104 100644 --- a/sdks/php/src/Model/ApiAppUpdateRequest.php +++ b/sdks/php/src/Model/ApiAppUpdateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ApiAppUpdateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class ApiAppUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppUpdateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'callback_url' => 'string', 'custom_logo_file' => '\SplFileObject', @@ -64,16 +64,16 @@ class ApiAppUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializab 'name' => 'string', 'oauth' => '\Dropbox\Sign\Model\SubOAuth', 'options' => '\Dropbox\Sign\Model\SubOptions', - 'white_labeling_options' => '\Dropbox\Sign\Model\SubWhiteLabelingOptions', + 'white_labeling_options' => '\Dropbox\Sign\Model\SubWhiteLabelingOptions' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'callback_url' => null, 'custom_logo_file' => 'binary', @@ -81,14 +81,14 @@ class ApiAppUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializab 'name' => null, 'oauth' => null, 'options' => null, - 'white_labeling_options' => null, + 'white_labeling_options' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'callback_url' => false, 'custom_logo_file' => false, @@ -96,14 +96,14 @@ class ApiAppUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializab 'name' => false, 'oauth' => false, 'options' => false, - 'white_labeling_options' => false, + 'white_labeling_options' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -128,6 +128,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -137,7 +139,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -147,7 +149,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -156,6 +158,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -164,6 +169,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -183,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'oauth' => 'oauth', 'options' => 'options', - 'white_labeling_options' => 'white_labeling_options', + 'white_labeling_options' => 'white_labeling_options' ]; /** @@ -198,7 +206,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'oauth' => 'setOauth', 'options' => 'setOptions', - 'white_labeling_options' => 'setWhiteLabelingOptions', + 'white_labeling_options' => 'setWhiteLabelingOptions' ]; /** @@ -213,7 +221,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'oauth' => 'getOauth', 'options' => 'getOptions', - 'white_labeling_options' => 'getWhiteLabelingOptions', + 'white_labeling_options' => 'getWhiteLabelingOptions' ]; /** @@ -257,6 +265,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -281,33 +290,34 @@ public function __construct(array $data = null) $this->setIfExists('white_labeling_options', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ApiAppUpdateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ApiAppUpdateRequest { /** @var ApiAppUpdateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ApiAppUpdateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -344,6 +354,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets callback_url * @@ -357,14 +368,14 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url the URL at which the API App should receive event callbacks + * @param string|null $callback_url The URL at which the API App should receive event callbacks. * * @return self */ - public function setCallbackUrl(?string $callback_url) + public function setCallbackUrl($callback_url) { if (is_null($callback_url)) { - throw new InvalidArgumentException('non-nullable callback_url cannot be null'); + throw new \InvalidArgumentException('non-nullable callback_url cannot be null'); } $this->container['callback_url'] = $callback_url; @@ -374,7 +385,7 @@ public function setCallbackUrl(?string $callback_url) /** * Gets custom_logo_file * - * @return SplFileObject|null + * @return \SplFileObject|null */ public function getCustomLogoFile() { @@ -384,14 +395,14 @@ public function getCustomLogoFile() /** * Sets custom_logo_file * - * @param SplFileObject|null $custom_logo_file An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) + * @param \SplFileObject|null $custom_logo_file An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) * * @return self */ - public function setCustomLogoFile(?SplFileObject $custom_logo_file) + public function setCustomLogoFile($custom_logo_file) { if (is_null($custom_logo_file)) { - throw new InvalidArgumentException('non-nullable custom_logo_file cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_logo_file cannot be null'); } $this->container['custom_logo_file'] = $custom_logo_file; @@ -411,18 +422,18 @@ public function getDomains() /** * Sets domains * - * @param string[]|null $domains the domain names the ApiApp will be associated with + * @param string[]|null $domains The domain names the ApiApp will be associated with. * * @return self */ - public function setDomains(?array $domains) + public function setDomains($domains) { if (is_null($domains)) { - throw new InvalidArgumentException('non-nullable domains cannot be null'); + throw new \InvalidArgumentException('non-nullable domains cannot be null'); } - if (count($domains) > 2) { - throw new InvalidArgumentException('invalid value for $domains when calling ApiAppUpdateRequest., number of items must be less than or equal to 2.'); + if ((count($domains) > 2)) { + throw new \InvalidArgumentException('invalid value for $domains when calling ApiAppUpdateRequest., number of items must be less than or equal to 2.'); } $this->container['domains'] = $domains; @@ -442,14 +453,14 @@ public function getName() /** * Sets name * - * @param string|null $name the name you want to assign to the ApiApp + * @param string|null $name The name you want to assign to the ApiApp. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -459,7 +470,7 @@ public function setName(?string $name) /** * Gets oauth * - * @return SubOAuth|null + * @return \Dropbox\Sign\Model\SubOAuth|null */ public function getOauth() { @@ -469,14 +480,14 @@ public function getOauth() /** * Sets oauth * - * @param SubOAuth|null $oauth oauth + * @param \Dropbox\Sign\Model\SubOAuth|null $oauth oauth * * @return self */ - public function setOauth(?SubOAuth $oauth) + public function setOauth($oauth) { if (is_null($oauth)) { - throw new InvalidArgumentException('non-nullable oauth cannot be null'); + throw new \InvalidArgumentException('non-nullable oauth cannot be null'); } $this->container['oauth'] = $oauth; @@ -486,7 +497,7 @@ public function setOauth(?SubOAuth $oauth) /** * Gets options * - * @return SubOptions|null + * @return \Dropbox\Sign\Model\SubOptions|null */ public function getOptions() { @@ -496,14 +507,14 @@ public function getOptions() /** * Sets options * - * @param SubOptions|null $options options + * @param \Dropbox\Sign\Model\SubOptions|null $options options * * @return self */ - public function setOptions(?SubOptions $options) + public function setOptions($options) { if (is_null($options)) { - throw new InvalidArgumentException('non-nullable options cannot be null'); + throw new \InvalidArgumentException('non-nullable options cannot be null'); } $this->container['options'] = $options; @@ -513,7 +524,7 @@ public function setOptions(?SubOptions $options) /** * Gets white_labeling_options * - * @return SubWhiteLabelingOptions|null + * @return \Dropbox\Sign\Model\SubWhiteLabelingOptions|null */ public function getWhiteLabelingOptions() { @@ -523,26 +534,27 @@ public function getWhiteLabelingOptions() /** * Sets white_labeling_options * - * @param SubWhiteLabelingOptions|null $white_labeling_options white_labeling_options + * @param \Dropbox\Sign\Model\SubWhiteLabelingOptions|null $white_labeling_options white_labeling_options * * @return self */ - public function setWhiteLabelingOptions(?SubWhiteLabelingOptions $white_labeling_options) + public function setWhiteLabelingOptions($white_labeling_options) { if (is_null($white_labeling_options)) { - throw new InvalidArgumentException('non-nullable white_labeling_options cannot be null'); + throw new \InvalidArgumentException('non-nullable white_labeling_options cannot be null'); } $this->container['white_labeling_options'] = $white_labeling_options; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -551,11 +563,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -566,8 +578,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -580,9 +594,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -590,15 +606,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -624,3 +640,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/BulkSendJobGetResponse.php b/sdks/php/src/Model/BulkSendJobGetResponse.php index 3d97f3fe5..4ebcbc1bb 100644 --- a/sdks/php/src/Model/BulkSendJobGetResponse.php +++ b/sdks/php/src/Model/BulkSendJobGetResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * BulkSendJobGetResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class BulkSendJobGetResponse implements ModelInterface, ArrayAccess, JsonSerializable +class BulkSendJobGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'BulkSendJobGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'bulk_send_job' => '\Dropbox\Sign\Model\BulkSendJobResponse', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', 'signature_requests' => '\Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[]', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'bulk_send_job' => null, 'list_info' => null, 'signature_requests' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'bulk_send_job' => false, 'list_info' => false, 'signature_requests' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job' => 'bulk_send_job', 'list_info' => 'list_info', 'signature_requests' => 'signature_requests', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job' => 'setBulkSendJob', 'list_info' => 'setListInfo', 'signature_requests' => 'setSignatureRequests', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job' => 'getBulkSendJob', 'list_info' => 'getListInfo', 'signature_requests' => 'getSignatureRequests', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -238,6 +247,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -259,33 +269,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): BulkSendJobGetResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): BulkSendJobGetResponse { /** @var BulkSendJobGetResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, BulkSendJobGetResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -327,10 +338,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets bulk_send_job * - * @return BulkSendJobResponse + * @return \Dropbox\Sign\Model\BulkSendJobResponse */ public function getBulkSendJob() { @@ -340,14 +352,14 @@ public function getBulkSendJob() /** * Sets bulk_send_job * - * @param BulkSendJobResponse $bulk_send_job bulk_send_job + * @param \Dropbox\Sign\Model\BulkSendJobResponse $bulk_send_job bulk_send_job * * @return self */ - public function setBulkSendJob(BulkSendJobResponse $bulk_send_job) + public function setBulkSendJob($bulk_send_job) { if (is_null($bulk_send_job)) { - throw new InvalidArgumentException('non-nullable bulk_send_job cannot be null'); + throw new \InvalidArgumentException('non-nullable bulk_send_job cannot be null'); } $this->container['bulk_send_job'] = $bulk_send_job; @@ -357,7 +369,7 @@ public function setBulkSendJob(BulkSendJobResponse $bulk_send_job) /** * Gets list_info * - * @return ListInfoResponse + * @return \Dropbox\Sign\Model\ListInfoResponse */ public function getListInfo() { @@ -367,14 +379,14 @@ public function getListInfo() /** * Sets list_info * - * @param ListInfoResponse $list_info list_info + * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo(ListInfoResponse $list_info) + public function setListInfo($list_info) { if (is_null($list_info)) { - throw new InvalidArgumentException('non-nullable list_info cannot be null'); + throw new \InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -384,7 +396,7 @@ public function setListInfo(ListInfoResponse $list_info) /** * Gets signature_requests * - * @return BulkSendJobGetResponseSignatureRequests[] + * @return \Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[] */ public function getSignatureRequests() { @@ -394,14 +406,14 @@ public function getSignatureRequests() /** * Sets signature_requests * - * @param BulkSendJobGetResponseSignatureRequests[] $signature_requests contains information about the Signature Requests sent in bulk + * @param \Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[] $signature_requests Contains information about the Signature Requests sent in bulk. * * @return self */ - public function setSignatureRequests(array $signature_requests) + public function setSignatureRequests($signature_requests) { if (is_null($signature_requests)) { - throw new InvalidArgumentException('non-nullable signature_requests cannot be null'); + throw new \InvalidArgumentException('non-nullable signature_requests cannot be null'); } $this->container['signature_requests'] = $signature_requests; @@ -411,7 +423,7 @@ public function setSignatureRequests(array $signature_requests) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -421,26 +433,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -449,11 +462,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -464,8 +477,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -478,9 +493,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -488,15 +505,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -522,3 +539,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php b/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php index 0781348c0..b7ab1008a 100644 --- a/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php +++ b/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,35 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * BulkSendJobGetResponseSignatureRequests Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAccess, JsonSerializable +class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'BulkSendJobGetResponseSignatureRequests'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'test_mode' => 'bool', 'signature_request_id' => 'string', @@ -81,16 +82,16 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', 'response_data' => '\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]', 'signatures' => '\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]', - 'bulk_send_job_id' => 'string', + 'bulk_send_job_id' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'test_mode' => null, 'signature_request_id' => null, @@ -116,14 +117,14 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc 'attachments' => null, 'response_data' => null, 'signatures' => null, - 'bulk_send_job_id' => null, + 'bulk_send_job_id' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'test_mode' => false, 'signature_request_id' => false, @@ -149,14 +150,14 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc 'attachments' => true, 'response_data' => true, 'signatures' => false, - 'bulk_send_job_id' => false, + 'bulk_send_job_id' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -181,6 +182,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -190,7 +193,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -200,7 +203,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -209,6 +212,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -217,6 +223,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -254,7 +263,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'attachments', 'response_data' => 'response_data', 'signatures' => 'signatures', - 'bulk_send_job_id' => 'bulk_send_job_id', + 'bulk_send_job_id' => 'bulk_send_job_id' ]; /** @@ -287,7 +296,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'setAttachments', 'response_data' => 'setResponseData', 'signatures' => 'setSignatures', - 'bulk_send_job_id' => 'setBulkSendJobId', + 'bulk_send_job_id' => 'setBulkSendJobId' ]; /** @@ -320,7 +329,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'getAttachments', 'response_data' => 'getResponseData', 'signatures' => 'getSignatures', - 'bulk_send_job_id' => 'getBulkSendJobId', + 'bulk_send_job_id' => 'getBulkSendJobId' ]; /** @@ -364,6 +373,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -406,33 +416,34 @@ public function __construct(array $data = null) $this->setIfExists('bulk_send_job_id', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): BulkSendJobGetResponseSignatureRequests { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): BulkSendJobGetResponseSignatureRequests { /** @var BulkSendJobGetResponseSignatureRequests */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, BulkSendJobGetResponseSignatureRequests::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -449,7 +460,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -463,6 +476,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets test_mode * @@ -480,10 +494,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -503,14 +517,14 @@ public function getSignatureRequestId() /** * Sets signature_request_id * - * @param string|null $signature_request_id the id of the SignatureRequest + * @param string|null $signature_request_id The id of the SignatureRequest. * * @return self */ - public function setSignatureRequestId(?string $signature_request_id) + public function setSignatureRequestId($signature_request_id) { if (is_null($signature_request_id)) { - throw new InvalidArgumentException('non-nullable signature_request_id cannot be null'); + throw new \InvalidArgumentException('non-nullable signature_request_id cannot be null'); } $this->container['signature_request_id'] = $signature_request_id; @@ -530,18 +544,18 @@ public function getRequesterEmailAddress() /** * Sets requester_email_address * - * @param string|null $requester_email_address the email address of the initiator of the SignatureRequest + * @param string|null $requester_email_address The email address of the initiator of the SignatureRequest. * * @return self */ - public function setRequesterEmailAddress(?string $requester_email_address) + public function setRequesterEmailAddress($requester_email_address) { if (is_null($requester_email_address)) { array_push($this->openAPINullablesSetToNull, 'requester_email_address'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('requester_email_address', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -564,14 +578,14 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title the specified Account uses for the SignatureRequest + * @param string|null $title The title the specified Account uses for the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -591,14 +605,14 @@ public function getOriginalTitle() /** * Sets original_title * - * @param string|null $original_title default Label for account + * @param string|null $original_title Default Label for account. * * @return self */ - public function setOriginalTitle(?string $original_title) + public function setOriginalTitle($original_title) { if (is_null($original_title)) { - throw new InvalidArgumentException('non-nullable original_title cannot be null'); + throw new \InvalidArgumentException('non-nullable original_title cannot be null'); } $this->container['original_title'] = $original_title; @@ -618,18 +632,18 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that was initially sent to the signers + * @param string|null $subject The subject in the email that was initially sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { array_push($this->openAPINullablesSetToNull, 'subject'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('subject', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -652,18 +666,18 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that was initially sent to the signers + * @param string|null $message The custom message in the email that was initially sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { array_push($this->openAPINullablesSetToNull, 'message'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('message', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -686,14 +700,14 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata the metadata attached to the signature request + * @param array|null $metadata The metadata attached to the signature request. * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } $this->container['metadata'] = $metadata; @@ -713,14 +727,14 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at time the signature request was created + * @param int|null $created_at Time the signature request was created. * * @return self */ - public function setCreatedAt(?int $created_at) + public function setCreatedAt($created_at) { if (is_null($created_at)) { - throw new InvalidArgumentException('non-nullable created_at cannot be null'); + throw new \InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; @@ -744,14 +758,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -774,14 +788,14 @@ public function getIsComplete() /** * Sets is_complete * - * @param bool|null $is_complete whether or not the SignatureRequest has been fully executed by all signers + * @param bool|null $is_complete Whether or not the SignatureRequest has been fully executed by all signers. * * @return self */ - public function setIsComplete(?bool $is_complete) + public function setIsComplete($is_complete) { if (is_null($is_complete)) { - throw new InvalidArgumentException('non-nullable is_complete cannot be null'); + throw new \InvalidArgumentException('non-nullable is_complete cannot be null'); } $this->container['is_complete'] = $is_complete; @@ -801,14 +815,14 @@ public function getIsDeclined() /** * Sets is_declined * - * @param bool|null $is_declined whether or not the SignatureRequest has been declined by a signer + * @param bool|null $is_declined Whether or not the SignatureRequest has been declined by a signer. * * @return self */ - public function setIsDeclined(?bool $is_declined) + public function setIsDeclined($is_declined) { if (is_null($is_declined)) { - throw new InvalidArgumentException('non-nullable is_declined cannot be null'); + throw new \InvalidArgumentException('non-nullable is_declined cannot be null'); } $this->container['is_declined'] = $is_declined; @@ -828,14 +842,14 @@ public function getHasError() /** * Sets has_error * - * @param bool|null $has_error whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings) + * @param bool|null $has_error Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). * * @return self */ - public function setHasError(?bool $has_error) + public function setHasError($has_error) { if (is_null($has_error)) { - throw new InvalidArgumentException('non-nullable has_error cannot be null'); + throw new \InvalidArgumentException('non-nullable has_error cannot be null'); } $this->container['has_error'] = $has_error; @@ -855,14 +869,14 @@ public function getFilesUrl() /** * Sets files_url * - * @param string|null $files_url the URL where a copy of the request's documents can be downloaded + * @param string|null $files_url The URL where a copy of the request's documents can be downloaded. * * @return self */ - public function setFilesUrl(?string $files_url) + public function setFilesUrl($files_url) { if (is_null($files_url)) { - throw new InvalidArgumentException('non-nullable files_url cannot be null'); + throw new \InvalidArgumentException('non-nullable files_url cannot be null'); } $this->container['files_url'] = $files_url; @@ -886,14 +900,14 @@ public function getSigningUrl() * * @return self */ - public function setSigningUrl(?string $signing_url) + public function setSigningUrl($signing_url) { if (is_null($signing_url)) { array_push($this->openAPINullablesSetToNull, 'signing_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signing_url', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -916,14 +930,14 @@ public function getDetailsUrl() /** * Sets details_url * - * @param string|null $details_url the URL where the requester and the signers can view the current status of the SignatureRequest + * @param string|null $details_url The URL where the requester and the signers can view the current status of the SignatureRequest. * * @return self */ - public function setDetailsUrl(?string $details_url) + public function setDetailsUrl($details_url) { if (is_null($details_url)) { - throw new InvalidArgumentException('non-nullable details_url cannot be null'); + throw new \InvalidArgumentException('non-nullable details_url cannot be null'); } $this->container['details_url'] = $details_url; @@ -947,10 +961,10 @@ public function getCcEmailAddresses() * * @return self */ - public function setCcEmailAddresses(?array $cc_email_addresses) + public function setCcEmailAddresses($cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -970,18 +984,18 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want the signer redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want the signer redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { array_push($this->openAPINullablesSetToNull, 'signing_redirect_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signing_redirect_url', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1008,14 +1022,14 @@ public function getFinalCopyUri() * * @return self */ - public function setFinalCopyUri(?string $final_copy_uri) + public function setFinalCopyUri($final_copy_uri) { if (is_null($final_copy_uri)) { array_push($this->openAPINullablesSetToNull, 'final_copy_uri'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('final_copy_uri', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1038,18 +1052,18 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[]|null $template_ids templates IDs used in this SignatureRequest (if any) + * @param string[]|null $template_ids Templates IDs used in this SignatureRequest (if any). * * @return self */ - public function setTemplateIds(?array $template_ids) + public function setTemplateIds($template_ids) { if (is_null($template_ids)) { array_push($this->openAPINullablesSetToNull, 'template_ids'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('template_ids', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1062,7 +1076,7 @@ public function setTemplateIds(?array $template_ids) /** * Gets custom_fields * - * @return SignatureRequestResponseCustomFieldBase[]|null + * @return \Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]|null */ public function getCustomFields() { @@ -1072,18 +1086,18 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SignatureRequestResponseCustomFieldBase[]|null $custom_fields An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * @param \Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]|null $custom_fields An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { array_push($this->openAPINullablesSetToNull, 'custom_fields'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('custom_fields', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1096,7 +1110,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets attachments * - * @return SignatureRequestResponseAttachment[]|null + * @return \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null */ public function getAttachments() { @@ -1106,18 +1120,18 @@ public function getAttachments() /** * Sets attachments * - * @param SignatureRequestResponseAttachment[]|null $attachments signer attachments + * @param \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null $attachments Signer attachments. * * @return self */ - public function setAttachments(?array $attachments) + public function setAttachments($attachments) { if (is_null($attachments)) { array_push($this->openAPINullablesSetToNull, 'attachments'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('attachments', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1130,7 +1144,7 @@ public function setAttachments(?array $attachments) /** * Gets response_data * - * @return SignatureRequestResponseDataBase[]|null + * @return \Dropbox\Sign\Model\SignatureRequestResponseDataBase[]|null */ public function getResponseData() { @@ -1140,18 +1154,18 @@ public function getResponseData() /** * Sets response_data * - * @param SignatureRequestResponseDataBase[]|null $response_data an array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers + * @param \Dropbox\Sign\Model\SignatureRequestResponseDataBase[]|null $response_data An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. * * @return self */ - public function setResponseData(?array $response_data) + public function setResponseData($response_data) { if (is_null($response_data)) { array_push($this->openAPINullablesSetToNull, 'response_data'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('response_data', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1164,7 +1178,7 @@ public function setResponseData(?array $response_data) /** * Gets signatures * - * @return SignatureRequestResponseSignatures[]|null + * @return \Dropbox\Sign\Model\SignatureRequestResponseSignatures[]|null */ public function getSignatures() { @@ -1174,14 +1188,14 @@ public function getSignatures() /** * Sets signatures * - * @param SignatureRequestResponseSignatures[]|null $signatures an array of signature objects, 1 for each signer + * @param \Dropbox\Sign\Model\SignatureRequestResponseSignatures[]|null $signatures An array of signature objects, 1 for each signer. * * @return self */ - public function setSignatures(?array $signatures) + public function setSignatures($signatures) { if (is_null($signatures)) { - throw new InvalidArgumentException('non-nullable signatures cannot be null'); + throw new \InvalidArgumentException('non-nullable signatures cannot be null'); } $this->container['signatures'] = $signatures; @@ -1201,26 +1215,27 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string|null $bulk_send_job_id the id of the BulkSendJob + * @param string|null $bulk_send_job_id The id of the BulkSendJob. * * @return self */ - public function setBulkSendJobId(?string $bulk_send_job_id) + public function setBulkSendJobId($bulk_send_job_id) { if (is_null($bulk_send_job_id)) { - throw new InvalidArgumentException('non-nullable bulk_send_job_id cannot be null'); + throw new \InvalidArgumentException('non-nullable bulk_send_job_id cannot be null'); } $this->container['bulk_send_job_id'] = $bulk_send_job_id; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1229,11 +1244,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1244,8 +1259,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1258,9 +1275,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1268,15 +1287,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1302,3 +1321,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/BulkSendJobListResponse.php b/sdks/php/src/Model/BulkSendJobListResponse.php index 8420c469f..0206d116e 100644 --- a/sdks/php/src/Model/BulkSendJobListResponse.php +++ b/sdks/php/src/Model/BulkSendJobListResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * BulkSendJobListResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class BulkSendJobListResponse implements ModelInterface, ArrayAccess, JsonSerializable +class BulkSendJobListResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'BulkSendJobListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'bulk_send_jobs' => '\Dropbox\Sign\Model\BulkSendJobResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'bulk_send_jobs' => null, 'list_info' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'bulk_send_jobs' => false, 'list_info' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'bulk_send_jobs' => 'bulk_send_jobs', 'list_info' => 'list_info', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'bulk_send_jobs' => 'setBulkSendJobs', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'bulk_send_jobs' => 'getBulkSendJobs', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): BulkSendJobListResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): BulkSendJobListResponse { /** @var BulkSendJobListResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, BulkSendJobListResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,10 +328,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets bulk_send_jobs * - * @return BulkSendJobResponse[] + * @return \Dropbox\Sign\Model\BulkSendJobResponse[] */ public function getBulkSendJobs() { @@ -330,14 +342,14 @@ public function getBulkSendJobs() /** * Sets bulk_send_jobs * - * @param BulkSendJobResponse[] $bulk_send_jobs contains a list of BulkSendJobs that the API caller has access to + * @param \Dropbox\Sign\Model\BulkSendJobResponse[] $bulk_send_jobs Contains a list of BulkSendJobs that the API caller has access to. * * @return self */ - public function setBulkSendJobs(array $bulk_send_jobs) + public function setBulkSendJobs($bulk_send_jobs) { if (is_null($bulk_send_jobs)) { - throw new InvalidArgumentException('non-nullable bulk_send_jobs cannot be null'); + throw new \InvalidArgumentException('non-nullable bulk_send_jobs cannot be null'); } $this->container['bulk_send_jobs'] = $bulk_send_jobs; @@ -347,7 +359,7 @@ public function setBulkSendJobs(array $bulk_send_jobs) /** * Gets list_info * - * @return ListInfoResponse + * @return \Dropbox\Sign\Model\ListInfoResponse */ public function getListInfo() { @@ -357,14 +369,14 @@ public function getListInfo() /** * Sets list_info * - * @param ListInfoResponse $list_info list_info + * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo(ListInfoResponse $list_info) + public function setListInfo($list_info) { if (is_null($list_info)) { - throw new InvalidArgumentException('non-nullable list_info cannot be null'); + throw new \InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -374,7 +386,7 @@ public function setListInfo(ListInfoResponse $list_info) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -384,26 +396,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -412,11 +425,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -427,8 +440,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -441,9 +456,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -451,15 +468,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -485,3 +502,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/BulkSendJobResponse.php b/sdks/php/src/Model/BulkSendJobResponse.php index fcd66e120..5a4bd69fc 100644 --- a/sdks/php/src/Model/BulkSendJobResponse.php +++ b/sdks/php/src/Model/BulkSendJobResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,74 +29,73 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * BulkSendJobResponse Class Doc Comment * * @category Class * @description Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class BulkSendJobResponse implements ModelInterface, ArrayAccess, JsonSerializable +class BulkSendJobResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'BulkSendJobResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'bulk_send_job_id' => 'string', 'total' => 'int', 'is_creator' => 'bool', - 'created_at' => 'int', + 'created_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'bulk_send_job_id' => null, 'total' => null, 'is_creator' => null, - 'created_at' => null, + 'created_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'bulk_send_job_id' => true, 'total' => false, 'is_creator' => false, - 'created_at' => false, + 'created_at' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,6 +120,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -128,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -138,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -147,6 +150,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -155,6 +161,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job_id' => 'bulk_send_job_id', 'total' => 'total', 'is_creator' => 'is_creator', - 'created_at' => 'created_at', + 'created_at' => 'created_at' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job_id' => 'setBulkSendJobId', 'total' => 'setTotal', 'is_creator' => 'setIsCreator', - 'created_at' => 'setCreatedAt', + 'created_at' => 'setCreatedAt' ]; /** @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job_id' => 'getBulkSendJobId', 'total' => 'getTotal', 'is_creator' => 'getIsCreator', - 'created_at' => 'getCreatedAt', + 'created_at' => 'getCreatedAt' ]; /** @@ -239,6 +248,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -260,33 +270,34 @@ public function __construct(array $data = null) $this->setIfExists('created_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): BulkSendJobResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): BulkSendJobResponse { /** @var BulkSendJobResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, BulkSendJobResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -303,7 +314,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -317,6 +330,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets bulk_send_job_id * @@ -330,18 +344,18 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string|null $bulk_send_job_id the id of the BulkSendJob + * @param string|null $bulk_send_job_id The id of the BulkSendJob. * * @return self */ - public function setBulkSendJobId(?string $bulk_send_job_id) + public function setBulkSendJobId($bulk_send_job_id) { if (is_null($bulk_send_job_id)) { array_push($this->openAPINullablesSetToNull, 'bulk_send_job_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('bulk_send_job_id', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -364,14 +378,14 @@ public function getTotal() /** * Sets total * - * @param int|null $total the total amount of Signature Requests queued for sending + * @param int|null $total The total amount of Signature Requests queued for sending. * * @return self */ - public function setTotal(?int $total) + public function setTotal($total) { if (is_null($total)) { - throw new InvalidArgumentException('non-nullable total cannot be null'); + throw new \InvalidArgumentException('non-nullable total cannot be null'); } $this->container['total'] = $total; @@ -391,14 +405,14 @@ public function getIsCreator() /** * Sets is_creator * - * @param bool|null $is_creator true if you are the owner of this BulkSendJob, false if it's been shared with you by a team member + * @param bool|null $is_creator True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. * * @return self */ - public function setIsCreator(?bool $is_creator) + public function setIsCreator($is_creator) { if (is_null($is_creator)) { - throw new InvalidArgumentException('non-nullable is_creator cannot be null'); + throw new \InvalidArgumentException('non-nullable is_creator cannot be null'); } $this->container['is_creator'] = $is_creator; @@ -418,26 +432,27 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at time that the BulkSendJob was created + * @param int|null $created_at Time that the BulkSendJob was created. * * @return self */ - public function setCreatedAt(?int $created_at) + public function setCreatedAt($created_at) { if (is_null($created_at)) { - throw new InvalidArgumentException('non-nullable created_at cannot be null'); + throw new \InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -446,11 +461,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -461,8 +476,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -475,9 +492,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -485,15 +504,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -519,3 +538,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/BulkSendJobSendResponse.php b/sdks/php/src/Model/BulkSendJobSendResponse.php index 7797e84c7..a91e1b01b 100644 --- a/sdks/php/src/Model/BulkSendJobSendResponse.php +++ b/sdks/php/src/Model/BulkSendJobSendResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * BulkSendJobSendResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class BulkSendJobSendResponse implements ModelInterface, ArrayAccess, JsonSerializable +class BulkSendJobSendResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'BulkSendJobSendResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'bulk_send_job' => '\Dropbox\Sign\Model\BulkSendJobResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'bulk_send_job' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'bulk_send_job' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'bulk_send_job' => 'bulk_send_job', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'bulk_send_job' => 'setBulkSendJob', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'bulk_send_job' => 'getBulkSendJob', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): BulkSendJobSendResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): BulkSendJobSendResponse { /** @var BulkSendJobSendResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, BulkSendJobSendResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets bulk_send_job * - * @return BulkSendJobResponse + * @return \Dropbox\Sign\Model\BulkSendJobResponse */ public function getBulkSendJob() { @@ -320,14 +332,14 @@ public function getBulkSendJob() /** * Sets bulk_send_job * - * @param BulkSendJobResponse $bulk_send_job bulk_send_job + * @param \Dropbox\Sign\Model\BulkSendJobResponse $bulk_send_job bulk_send_job * * @return self */ - public function setBulkSendJob(BulkSendJobResponse $bulk_send_job) + public function setBulkSendJob($bulk_send_job) { if (is_null($bulk_send_job)) { - throw new InvalidArgumentException('non-nullable bulk_send_job cannot be null'); + throw new \InvalidArgumentException('non-nullable bulk_send_job cannot be null'); } $this->container['bulk_send_job'] = $bulk_send_job; @@ -337,7 +349,7 @@ public function setBulkSendJob(BulkSendJobResponse $bulk_send_job) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/EmbeddedEditUrlRequest.php b/sdks/php/src/Model/EmbeddedEditUrlRequest.php index b4992a4c8..5df70bdf1 100644 --- a/sdks/php/src/Model/EmbeddedEditUrlRequest.php +++ b/sdks/php/src/Model/EmbeddedEditUrlRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,35 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * EmbeddedEditUrlRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSerializable +class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EmbeddedEditUrlRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'allow_edit_ccs' => 'bool', 'cc_roles' => 'string[]', @@ -66,16 +67,16 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali 'preview_only' => 'bool', 'show_preview' => 'bool', 'show_progress_stepper' => 'bool', - 'test_mode' => 'bool', + 'test_mode' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'allow_edit_ccs' => null, 'cc_roles' => null, @@ -86,14 +87,14 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali 'preview_only' => null, 'show_preview' => null, 'show_progress_stepper' => null, - 'test_mode' => null, + 'test_mode' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'allow_edit_ccs' => false, 'cc_roles' => false, @@ -104,14 +105,14 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali 'preview_only' => false, 'show_preview' => false, 'show_progress_stepper' => false, - 'test_mode' => false, + 'test_mode' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -136,6 +137,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -145,7 +148,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -155,7 +158,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -164,6 +167,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -172,6 +178,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'preview_only' => 'preview_only', 'show_preview' => 'show_preview', 'show_progress_stepper' => 'show_progress_stepper', - 'test_mode' => 'test_mode', + 'test_mode' => 'test_mode' ]; /** @@ -212,7 +221,7 @@ public function isNullableSetToNull(string $property): bool 'preview_only' => 'setPreviewOnly', 'show_preview' => 'setShowPreview', 'show_progress_stepper' => 'setShowProgressStepper', - 'test_mode' => 'setTestMode', + 'test_mode' => 'setTestMode' ]; /** @@ -230,7 +239,7 @@ public function isNullableSetToNull(string $property): bool 'preview_only' => 'getPreviewOnly', 'show_preview' => 'getShowPreview', 'show_progress_stepper' => 'getShowProgressStepper', - 'test_mode' => 'getTestMode', + 'test_mode' => 'getTestMode' ]; /** @@ -274,6 +283,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -301,33 +311,34 @@ public function __construct(array $data = null) $this->setIfExists('test_mode', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): EmbeddedEditUrlRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): EmbeddedEditUrlRequest { /** @var EmbeddedEditUrlRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, EmbeddedEditUrlRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -344,7 +355,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -358,6 +371,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets allow_edit_ccs * @@ -371,14 +385,14 @@ public function getAllowEditCcs() /** * Sets allow_edit_ccs * - * @param bool|null $allow_edit_ccs this allows the requester to enable/disable to add or change CC roles when editing the template + * @param bool|null $allow_edit_ccs This allows the requester to enable/disable to add or change CC roles when editing the template. * * @return self */ - public function setAllowEditCcs(?bool $allow_edit_ccs) + public function setAllowEditCcs($allow_edit_ccs) { if (is_null($allow_edit_ccs)) { - throw new InvalidArgumentException('non-nullable allow_edit_ccs cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_edit_ccs cannot be null'); } $this->container['allow_edit_ccs'] = $allow_edit_ccs; @@ -402,10 +416,10 @@ public function getCcRoles() * * @return self */ - public function setCcRoles(?array $cc_roles) + public function setCcRoles($cc_roles) { if (is_null($cc_roles)) { - throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); + throw new \InvalidArgumentException('non-nullable cc_roles cannot be null'); } $this->container['cc_roles'] = $cc_roles; @@ -415,7 +429,7 @@ public function setCcRoles(?array $cc_roles) /** * Gets editor_options * - * @return SubEditorOptions|null + * @return \Dropbox\Sign\Model\SubEditorOptions|null */ public function getEditorOptions() { @@ -425,14 +439,14 @@ public function getEditorOptions() /** * Sets editor_options * - * @param SubEditorOptions|null $editor_options editor_options + * @param \Dropbox\Sign\Model\SubEditorOptions|null $editor_options editor_options * * @return self */ - public function setEditorOptions(?SubEditorOptions $editor_options) + public function setEditorOptions($editor_options) { if (is_null($editor_options)) { - throw new InvalidArgumentException('non-nullable editor_options cannot be null'); + throw new \InvalidArgumentException('non-nullable editor_options cannot be null'); } $this->container['editor_options'] = $editor_options; @@ -452,14 +466,14 @@ public function getForceSignerRoles() /** * Sets force_signer_roles * - * @param bool|null $force_signer_roles provide users the ability to review/edit the template signer roles + * @param bool|null $force_signer_roles Provide users the ability to review/edit the template signer roles. * * @return self */ - public function setForceSignerRoles(?bool $force_signer_roles) + public function setForceSignerRoles($force_signer_roles) { if (is_null($force_signer_roles)) { - throw new InvalidArgumentException('non-nullable force_signer_roles cannot be null'); + throw new \InvalidArgumentException('non-nullable force_signer_roles cannot be null'); } $this->container['force_signer_roles'] = $force_signer_roles; @@ -479,14 +493,14 @@ public function getForceSubjectMessage() /** * Sets force_subject_message * - * @param bool|null $force_subject_message provide users the ability to review/edit the template subject and message + * @param bool|null $force_subject_message Provide users the ability to review/edit the template subject and message. * * @return self */ - public function setForceSubjectMessage(?bool $force_subject_message) + public function setForceSubjectMessage($force_subject_message) { if (is_null($force_subject_message)) { - throw new InvalidArgumentException('non-nullable force_subject_message cannot be null'); + throw new \InvalidArgumentException('non-nullable force_subject_message cannot be null'); } $this->container['force_subject_message'] = $force_subject_message; @@ -496,7 +510,7 @@ public function setForceSubjectMessage(?bool $force_subject_message) /** * Gets merge_fields * - * @return SubMergeField[]|null + * @return \Dropbox\Sign\Model\SubMergeField[]|null */ public function getMergeFields() { @@ -506,14 +520,14 @@ public function getMergeFields() /** * Sets merge_fields * - * @param SubMergeField[]|null $merge_fields Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. Remove all merge fields on the template by passing an empty array `[]`. + * @param \Dropbox\Sign\Model\SubMergeField[]|null $merge_fields Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. Remove all merge fields on the template by passing an empty array `[]`. * * @return self */ - public function setMergeFields(?array $merge_fields) + public function setMergeFields($merge_fields) { if (is_null($merge_fields)) { - throw new InvalidArgumentException('non-nullable merge_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable merge_fields cannot be null'); } $this->container['merge_fields'] = $merge_fields; @@ -537,10 +551,10 @@ public function getPreviewOnly() * * @return self */ - public function setPreviewOnly(?bool $preview_only) + public function setPreviewOnly($preview_only) { if (is_null($preview_only)) { - throw new InvalidArgumentException('non-nullable preview_only cannot be null'); + throw new \InvalidArgumentException('non-nullable preview_only cannot be null'); } $this->container['preview_only'] = $preview_only; @@ -560,14 +574,14 @@ public function getShowPreview() /** * Sets show_preview * - * @param bool|null $show_preview this allows the requester to enable the editor/preview experience + * @param bool|null $show_preview This allows the requester to enable the editor/preview experience. * * @return self */ - public function setShowPreview(?bool $show_preview) + public function setShowPreview($show_preview) { if (is_null($show_preview)) { - throw new InvalidArgumentException('non-nullable show_preview cannot be null'); + throw new \InvalidArgumentException('non-nullable show_preview cannot be null'); } $this->container['show_preview'] = $show_preview; @@ -587,14 +601,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden + * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. * * @return self */ - public function setShowProgressStepper(?bool $show_progress_stepper) + public function setShowProgressStepper($show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -618,22 +632,23 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -642,11 +657,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -657,8 +672,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -671,9 +688,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -681,15 +700,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -715,3 +734,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/EmbeddedEditUrlResponse.php b/sdks/php/src/Model/EmbeddedEditUrlResponse.php index 88320ef63..413b0317a 100644 --- a/sdks/php/src/Model/EmbeddedEditUrlResponse.php +++ b/sdks/php/src/Model/EmbeddedEditUrlResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * EmbeddedEditUrlResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class EmbeddedEditUrlResponse implements ModelInterface, ArrayAccess, JsonSerializable +class EmbeddedEditUrlResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EmbeddedEditUrlResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'embedded' => '\Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'embedded' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'embedded' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'embedded' => 'embedded', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'embedded' => 'setEmbedded', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'embedded' => 'getEmbedded', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): EmbeddedEditUrlResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): EmbeddedEditUrlResponse { /** @var EmbeddedEditUrlResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, EmbeddedEditUrlResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets embedded * - * @return EmbeddedEditUrlResponseEmbedded + * @return \Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded */ public function getEmbedded() { @@ -320,14 +332,14 @@ public function getEmbedded() /** * Sets embedded * - * @param EmbeddedEditUrlResponseEmbedded $embedded embedded + * @param \Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded $embedded embedded * * @return self */ - public function setEmbedded(EmbeddedEditUrlResponseEmbedded $embedded) + public function setEmbedded($embedded) { if (is_null($embedded)) { - throw new InvalidArgumentException('non-nullable embedded cannot be null'); + throw new \InvalidArgumentException('non-nullable embedded cannot be null'); } $this->container['embedded'] = $embedded; @@ -337,7 +349,7 @@ public function setEmbedded(EmbeddedEditUrlResponseEmbedded $embedded) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php b/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php index 0ef35374f..30f0a4649 100644 --- a/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php +++ b/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,68 +29,67 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * EmbeddedEditUrlResponseEmbedded Class Doc Comment * * @category Class * @description An embedded template object. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class EmbeddedEditUrlResponseEmbedded implements ModelInterface, ArrayAccess, JsonSerializable +class EmbeddedEditUrlResponseEmbedded implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EmbeddedEditUrlResponseEmbedded'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'edit_url' => 'string', - 'expires_at' => 'int', + 'expires_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'edit_url' => null, - 'expires_at' => null, + 'expires_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'edit_url' => false, - 'expires_at' => false, + 'expires_at' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -163,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'edit_url' => 'edit_url', - 'expires_at' => 'expires_at', + 'expires_at' => 'expires_at' ]; /** @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'edit_url' => 'setEditUrl', - 'expires_at' => 'setExpiresAt', + 'expires_at' => 'setExpiresAt' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'edit_url' => 'getEditUrl', - 'expires_at' => 'getExpiresAt', + 'expires_at' => 'getExpiresAt' ]; /** @@ -227,6 +236,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -246,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): EmbeddedEditUrlResponseEmbedded { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): EmbeddedEditUrlResponseEmbedded { /** @var EmbeddedEditUrlResponseEmbedded */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, EmbeddedEditUrlResponseEmbedded::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -289,7 +300,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -303,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets edit_url * @@ -316,14 +330,14 @@ public function getEditUrl() /** * Sets edit_url * - * @param string|null $edit_url a template url that can be opened in an iFrame + * @param string|null $edit_url A template url that can be opened in an iFrame. * * @return self */ - public function setEditUrl(?string $edit_url) + public function setEditUrl($edit_url) { if (is_null($edit_url)) { - throw new InvalidArgumentException('non-nullable edit_url cannot be null'); + throw new \InvalidArgumentException('non-nullable edit_url cannot be null'); } $this->container['edit_url'] = $edit_url; @@ -343,26 +357,27 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at the specific time that the the `edit_url` link expires, in epoch + * @param int|null $expires_at The specific time that the the `edit_url` link expires, in epoch. * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { - throw new InvalidArgumentException('non-nullable expires_at cannot be null'); + throw new \InvalidArgumentException('non-nullable expires_at cannot be null'); } $this->container['expires_at'] = $expires_at; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -371,11 +386,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -386,8 +401,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -400,9 +417,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -410,15 +429,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -444,3 +463,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/EmbeddedSignUrlResponse.php b/sdks/php/src/Model/EmbeddedSignUrlResponse.php index 4f91647aa..e2e7dc89a 100644 --- a/sdks/php/src/Model/EmbeddedSignUrlResponse.php +++ b/sdks/php/src/Model/EmbeddedSignUrlResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * EmbeddedSignUrlResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class EmbeddedSignUrlResponse implements ModelInterface, ArrayAccess, JsonSerializable +class EmbeddedSignUrlResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EmbeddedSignUrlResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'embedded' => '\Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'embedded' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'embedded' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'embedded' => 'embedded', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'embedded' => 'setEmbedded', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'embedded' => 'getEmbedded', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): EmbeddedSignUrlResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): EmbeddedSignUrlResponse { /** @var EmbeddedSignUrlResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, EmbeddedSignUrlResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets embedded * - * @return EmbeddedSignUrlResponseEmbedded + * @return \Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded */ public function getEmbedded() { @@ -320,14 +332,14 @@ public function getEmbedded() /** * Sets embedded * - * @param EmbeddedSignUrlResponseEmbedded $embedded embedded + * @param \Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded $embedded embedded * * @return self */ - public function setEmbedded(EmbeddedSignUrlResponseEmbedded $embedded) + public function setEmbedded($embedded) { if (is_null($embedded)) { - throw new InvalidArgumentException('non-nullable embedded cannot be null'); + throw new \InvalidArgumentException('non-nullable embedded cannot be null'); } $this->container['embedded'] = $embedded; @@ -337,7 +349,7 @@ public function setEmbedded(EmbeddedSignUrlResponseEmbedded $embedded) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php b/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php index f8b6619ba..27d64cb28 100644 --- a/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php +++ b/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,68 +29,67 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * EmbeddedSignUrlResponseEmbedded Class Doc Comment * * @category Class * @description An object that contains necessary information to set up embedded signing. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class EmbeddedSignUrlResponseEmbedded implements ModelInterface, ArrayAccess, JsonSerializable +class EmbeddedSignUrlResponseEmbedded implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EmbeddedSignUrlResponseEmbedded'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'sign_url' => 'string', - 'expires_at' => 'int', + 'expires_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'sign_url' => null, - 'expires_at' => null, + 'expires_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'sign_url' => false, - 'expires_at' => false, + 'expires_at' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -163,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'sign_url' => 'sign_url', - 'expires_at' => 'expires_at', + 'expires_at' => 'expires_at' ]; /** @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'sign_url' => 'setSignUrl', - 'expires_at' => 'setExpiresAt', + 'expires_at' => 'setExpiresAt' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'sign_url' => 'getSignUrl', - 'expires_at' => 'getExpiresAt', + 'expires_at' => 'getExpiresAt' ]; /** @@ -227,6 +236,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -246,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): EmbeddedSignUrlResponseEmbedded { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): EmbeddedSignUrlResponseEmbedded { /** @var EmbeddedSignUrlResponseEmbedded */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, EmbeddedSignUrlResponseEmbedded::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -289,7 +300,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -303,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets sign_url * @@ -316,14 +330,14 @@ public function getSignUrl() /** * Sets sign_url * - * @param string|null $sign_url a signature url that can be opened in an iFrame + * @param string|null $sign_url A signature url that can be opened in an iFrame. * * @return self */ - public function setSignUrl(?string $sign_url) + public function setSignUrl($sign_url) { if (is_null($sign_url)) { - throw new InvalidArgumentException('non-nullable sign_url cannot be null'); + throw new \InvalidArgumentException('non-nullable sign_url cannot be null'); } $this->container['sign_url'] = $sign_url; @@ -343,26 +357,27 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at the specific time that the the `sign_url` link expires, in epoch + * @param int|null $expires_at The specific time that the the `sign_url` link expires, in epoch. * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { - throw new InvalidArgumentException('non-nullable expires_at cannot be null'); + throw new \InvalidArgumentException('non-nullable expires_at cannot be null'); } $this->container['expires_at'] = $expires_at; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -371,11 +386,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -386,8 +401,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -400,9 +417,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -410,15 +429,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -444,3 +463,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ErrorResponse.php b/sdks/php/src/Model/ErrorResponse.php index 081ed78c0..90fe0ec84 100644 --- a/sdks/php/src/Model/ErrorResponse.php +++ b/sdks/php/src/Model/ErrorResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ErrorResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ErrorResponse implements ModelInterface, ArrayAccess, JsonSerializable +class ErrorResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ErrorResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'error' => '\Dropbox\Sign\Model\ErrorResponseError', + 'error' => '\Dropbox\Sign\Model\ErrorResponseError' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'error' => null, + 'error' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'error' => false, + 'error' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'error' => 'error', + 'error' => 'error' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'error' => 'setError', + 'error' => 'setError' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'error' => 'getError', + 'error' => 'getError' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('error', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ErrorResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ErrorResponse { /** @var ErrorResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ErrorResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,10 +311,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets error * - * @return ErrorResponseError + * @return \Dropbox\Sign\Model\ErrorResponseError */ public function getError() { @@ -313,26 +325,27 @@ public function getError() /** * Sets error * - * @param ErrorResponseError $error error + * @param \Dropbox\Sign\Model\ErrorResponseError $error error * * @return self */ - public function setError(ErrorResponseError $error) + public function setError($error) { if (is_null($error)) { - throw new InvalidArgumentException('non-nullable error cannot be null'); + throw new \InvalidArgumentException('non-nullable error cannot be null'); } $this->container['error'] = $error; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -341,11 +354,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -356,8 +369,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -370,9 +385,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -380,15 +397,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -414,3 +431,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ErrorResponseError.php b/sdks/php/src/Model/ErrorResponseError.php index 60981920d..eefb72ff1 100644 --- a/sdks/php/src/Model/ErrorResponseError.php +++ b/sdks/php/src/Model/ErrorResponseError.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,71 +29,70 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ErrorResponseError Class Doc Comment * * @category Class * @description Contains information about an error that occurred. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ErrorResponseError implements ModelInterface, ArrayAccess, JsonSerializable +class ErrorResponseError implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ErrorResponseError'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'error_msg' => 'string', 'error_name' => 'string', - 'error_path' => 'string', + 'error_path' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'error_msg' => null, 'error_name' => null, - 'error_path' => null, + 'error_path' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'error_msg' => false, 'error_name' => false, - 'error_path' => false, + 'error_path' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,6 +117,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -125,7 +128,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +138,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,6 +147,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -152,6 +158,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'error_msg' => 'error_msg', 'error_name' => 'error_name', - 'error_path' => 'error_path', + 'error_path' => 'error_path' ]; /** @@ -178,7 +187,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'error_msg' => 'setErrorMsg', 'error_name' => 'setErrorName', - 'error_path' => 'setErrorPath', + 'error_path' => 'setErrorPath' ]; /** @@ -189,7 +198,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'error_msg' => 'getErrorMsg', 'error_name' => 'getErrorName', - 'error_path' => 'getErrorPath', + 'error_path' => 'getErrorPath' ]; /** @@ -233,6 +242,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -253,33 +263,34 @@ public function __construct(array $data = null) $this->setIfExists('error_path', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ErrorResponseError { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ErrorResponseError { /** @var ErrorResponseError */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ErrorResponseError::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,6 +329,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets error_msg * @@ -331,14 +343,14 @@ public function getErrorMsg() /** * Sets error_msg * - * @param string $error_msg message describing an error + * @param string $error_msg Message describing an error. * * @return self */ - public function setErrorMsg(string $error_msg) + public function setErrorMsg($error_msg) { if (is_null($error_msg)) { - throw new InvalidArgumentException('non-nullable error_msg cannot be null'); + throw new \InvalidArgumentException('non-nullable error_msg cannot be null'); } $this->container['error_msg'] = $error_msg; @@ -358,14 +370,14 @@ public function getErrorName() /** * Sets error_name * - * @param string $error_name name of the error + * @param string $error_name Name of the error. * * @return self */ - public function setErrorName(string $error_name) + public function setErrorName($error_name) { if (is_null($error_name)) { - throw new InvalidArgumentException('non-nullable error_name cannot be null'); + throw new \InvalidArgumentException('non-nullable error_name cannot be null'); } $this->container['error_name'] = $error_name; @@ -385,26 +397,27 @@ public function getErrorPath() /** * Sets error_path * - * @param string|null $error_path path at which an error occurred + * @param string|null $error_path Path at which an error occurred. * * @return self */ - public function setErrorPath(?string $error_path) + public function setErrorPath($error_path) { if (is_null($error_path)) { - throw new InvalidArgumentException('non-nullable error_path cannot be null'); + throw new \InvalidArgumentException('non-nullable error_path cannot be null'); } $this->container['error_path'] = $error_path; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -413,11 +426,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -428,8 +441,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -442,9 +457,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -452,15 +469,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -486,3 +503,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/EventCallbackRequest.php b/sdks/php/src/Model/EventCallbackRequest.php index 35c806b2d..840fc6b27 100644 --- a/sdks/php/src/Model/EventCallbackRequest.php +++ b/sdks/php/src/Model/EventCallbackRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * EventCallbackRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class EventCallbackRequest implements ModelInterface, ArrayAccess, JsonSerializable +class EventCallbackRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EventCallbackRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'event' => '\Dropbox\Sign\Model\EventCallbackRequestEvent', 'account' => '\Dropbox\Sign\Model\AccountResponse', 'signature_request' => '\Dropbox\Sign\Model\SignatureRequestResponse', - 'template' => '\Dropbox\Sign\Model\TemplateResponse', + 'template' => '\Dropbox\Sign\Model\TemplateResponse' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'event' => null, 'account' => null, 'signature_request' => null, - 'template' => null, + 'template' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'event' => false, 'account' => false, 'signature_request' => false, - 'template' => false, + 'template' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'event' => 'event', 'account' => 'account', 'signature_request' => 'signature_request', - 'template' => 'template', + 'template' => 'template' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'event' => 'setEvent', 'account' => 'setAccount', 'signature_request' => 'setSignatureRequest', - 'template' => 'setTemplate', + 'template' => 'setTemplate' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'event' => 'getEvent', 'account' => 'getAccount', 'signature_request' => 'getSignatureRequest', - 'template' => 'getTemplate', + 'template' => 'getTemplate' ]; /** @@ -238,6 +247,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -259,33 +269,34 @@ public function __construct(array $data = null) $this->setIfExists('template', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): EventCallbackRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): EventCallbackRequest { /** @var EventCallbackRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, EventCallbackRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -321,10 +332,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets event * - * @return EventCallbackRequestEvent + * @return \Dropbox\Sign\Model\EventCallbackRequestEvent */ public function getEvent() { @@ -334,14 +346,14 @@ public function getEvent() /** * Sets event * - * @param EventCallbackRequestEvent $event event + * @param \Dropbox\Sign\Model\EventCallbackRequestEvent $event event * * @return self */ - public function setEvent(EventCallbackRequestEvent $event) + public function setEvent($event) { if (is_null($event)) { - throw new InvalidArgumentException('non-nullable event cannot be null'); + throw new \InvalidArgumentException('non-nullable event cannot be null'); } $this->container['event'] = $event; @@ -351,7 +363,7 @@ public function setEvent(EventCallbackRequestEvent $event) /** * Gets account * - * @return AccountResponse|null + * @return \Dropbox\Sign\Model\AccountResponse|null */ public function getAccount() { @@ -361,14 +373,14 @@ public function getAccount() /** * Sets account * - * @param AccountResponse|null $account account + * @param \Dropbox\Sign\Model\AccountResponse|null $account account * * @return self */ - public function setAccount(?AccountResponse $account) + public function setAccount($account) { if (is_null($account)) { - throw new InvalidArgumentException('non-nullable account cannot be null'); + throw new \InvalidArgumentException('non-nullable account cannot be null'); } $this->container['account'] = $account; @@ -378,7 +390,7 @@ public function setAccount(?AccountResponse $account) /** * Gets signature_request * - * @return SignatureRequestResponse|null + * @return \Dropbox\Sign\Model\SignatureRequestResponse|null */ public function getSignatureRequest() { @@ -388,14 +400,14 @@ public function getSignatureRequest() /** * Sets signature_request * - * @param SignatureRequestResponse|null $signature_request signature_request + * @param \Dropbox\Sign\Model\SignatureRequestResponse|null $signature_request signature_request * * @return self */ - public function setSignatureRequest(?SignatureRequestResponse $signature_request) + public function setSignatureRequest($signature_request) { if (is_null($signature_request)) { - throw new InvalidArgumentException('non-nullable signature_request cannot be null'); + throw new \InvalidArgumentException('non-nullable signature_request cannot be null'); } $this->container['signature_request'] = $signature_request; @@ -405,7 +417,7 @@ public function setSignatureRequest(?SignatureRequestResponse $signature_request /** * Gets template * - * @return TemplateResponse|null + * @return \Dropbox\Sign\Model\TemplateResponse|null */ public function getTemplate() { @@ -415,26 +427,27 @@ public function getTemplate() /** * Sets template * - * @param TemplateResponse|null $template template + * @param \Dropbox\Sign\Model\TemplateResponse|null $template template * * @return self */ - public function setTemplate(?TemplateResponse $template) + public function setTemplate($template) { if (is_null($template)) { - throw new InvalidArgumentException('non-nullable template cannot be null'); + throw new \InvalidArgumentException('non-nullable template cannot be null'); } $this->container['template'] = $template; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -443,11 +456,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -458,8 +471,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -472,9 +487,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -482,15 +499,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -516,3 +533,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/EventCallbackRequestEvent.php b/sdks/php/src/Model/EventCallbackRequestEvent.php index 36d99c767..35d62f1a1 100644 --- a/sdks/php/src/Model/EventCallbackRequestEvent.php +++ b/sdks/php/src/Model/EventCallbackRequestEvent.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,74 +29,73 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * EventCallbackRequestEvent Class Doc Comment * * @category Class * @description Basic information about the event that occurred. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class EventCallbackRequestEvent implements ModelInterface, ArrayAccess, JsonSerializable +class EventCallbackRequestEvent implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EventCallbackRequestEvent'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'event_time' => 'string', 'event_type' => 'string', 'event_hash' => 'string', - 'event_metadata' => '\Dropbox\Sign\Model\EventCallbackRequestEventMetadata', + 'event_metadata' => '\Dropbox\Sign\Model\EventCallbackRequestEventMetadata' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'event_time' => null, 'event_type' => null, 'event_hash' => null, - 'event_metadata' => null, + 'event_metadata' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'event_time' => false, 'event_type' => false, 'event_hash' => false, - 'event_metadata' => false, + 'event_metadata' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,6 +120,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -128,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -138,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -147,6 +150,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -155,6 +161,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool 'event_time' => 'event_time', 'event_type' => 'event_type', 'event_hash' => 'event_hash', - 'event_metadata' => 'event_metadata', + 'event_metadata' => 'event_metadata' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'event_time' => 'setEventTime', 'event_type' => 'setEventType', 'event_hash' => 'setEventHash', - 'event_metadata' => 'setEventMetadata', + 'event_metadata' => 'setEventMetadata' ]; /** @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'event_time' => 'getEventTime', 'event_type' => 'getEventType', 'event_hash' => 'getEventHash', - 'event_metadata' => 'getEventMetadata', + 'event_metadata' => 'getEventMetadata' ]; /** @@ -318,33 +327,34 @@ public function __construct(array $data = null) $this->setIfExists('event_metadata', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): EventCallbackRequestEvent { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): EventCallbackRequestEvent { /** @var EventCallbackRequestEvent */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, EventCallbackRequestEvent::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -395,6 +405,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets event_time * @@ -408,14 +419,14 @@ public function getEventTime() /** * Sets event_time * - * @param string $event_time time the event was created (using Unix time) + * @param string $event_time Time the event was created (using Unix time). * * @return self */ - public function setEventTime(string $event_time) + public function setEventTime($event_time) { if (is_null($event_time)) { - throw new InvalidArgumentException('non-nullable event_time cannot be null'); + throw new \InvalidArgumentException('non-nullable event_time cannot be null'); } $this->container['event_time'] = $event_time; @@ -435,18 +446,18 @@ public function getEventType() /** * Sets event_type * - * @param string $event_type type of callback event that was triggered + * @param string $event_type Type of callback event that was triggered. * * @return self */ - public function setEventType(string $event_type) + public function setEventType($event_type) { if (is_null($event_type)) { - throw new InvalidArgumentException('non-nullable event_type cannot be null'); + throw new \InvalidArgumentException('non-nullable event_type cannot be null'); } $allowedValues = $this->getEventTypeAllowableValues(); if (!in_array($event_type, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'event_type', must be one of '%s'", $event_type, @@ -472,14 +483,14 @@ public function getEventHash() /** * Sets event_hash * - * @param string $event_hash generated hash used to verify source of event data + * @param string $event_hash Generated hash used to verify source of event data. * * @return self */ - public function setEventHash(string $event_hash) + public function setEventHash($event_hash) { if (is_null($event_hash)) { - throw new InvalidArgumentException('non-nullable event_hash cannot be null'); + throw new \InvalidArgumentException('non-nullable event_hash cannot be null'); } $this->container['event_hash'] = $event_hash; @@ -489,7 +500,7 @@ public function setEventHash(string $event_hash) /** * Gets event_metadata * - * @return EventCallbackRequestEventMetadata|null + * @return \Dropbox\Sign\Model\EventCallbackRequestEventMetadata|null */ public function getEventMetadata() { @@ -499,26 +510,27 @@ public function getEventMetadata() /** * Sets event_metadata * - * @param EventCallbackRequestEventMetadata|null $event_metadata event_metadata + * @param \Dropbox\Sign\Model\EventCallbackRequestEventMetadata|null $event_metadata event_metadata * * @return self */ - public function setEventMetadata(?EventCallbackRequestEventMetadata $event_metadata) + public function setEventMetadata($event_metadata) { if (is_null($event_metadata)) { - throw new InvalidArgumentException('non-nullable event_metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable event_metadata cannot be null'); } $this->container['event_metadata'] = $event_metadata; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -527,11 +539,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -542,8 +554,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -556,9 +570,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -566,15 +582,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -600,3 +616,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/EventCallbackRequestEventMetadata.php b/sdks/php/src/Model/EventCallbackRequestEventMetadata.php index c0d665c8c..06146a871 100644 --- a/sdks/php/src/Model/EventCallbackRequestEventMetadata.php +++ b/sdks/php/src/Model/EventCallbackRequestEventMetadata.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,73 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * EventCallbackRequestEventMetadata Class Doc Comment * * @category Class * @description Specific metadata about the event. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class EventCallbackRequestEventMetadata implements ModelInterface, ArrayAccess, JsonSerializable +class EventCallbackRequestEventMetadata implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EventCallbackRequestEventMetadata'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'related_signature_id' => 'string', 'reported_for_account_id' => 'string', 'reported_for_app_id' => 'string', - 'event_message' => 'string', + 'event_message' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'related_signature_id' => null, 'reported_for_account_id' => null, 'reported_for_app_id' => null, - 'event_message' => null, + 'event_message' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'related_signature_id' => true, 'reported_for_account_id' => true, 'reported_for_app_id' => true, - 'event_message' => true, + 'event_message' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +120,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +150,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +161,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +180,7 @@ public function isNullableSetToNull(string $property): bool 'related_signature_id' => 'related_signature_id', 'reported_for_account_id' => 'reported_for_account_id', 'reported_for_app_id' => 'reported_for_app_id', - 'event_message' => 'event_message', + 'event_message' => 'event_message' ]; /** @@ -182,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'related_signature_id' => 'setRelatedSignatureId', 'reported_for_account_id' => 'setReportedForAccountId', 'reported_for_app_id' => 'setReportedForAppId', - 'event_message' => 'setEventMessage', + 'event_message' => 'setEventMessage' ]; /** @@ -194,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'related_signature_id' => 'getRelatedSignatureId', 'reported_for_account_id' => 'getReportedForAccountId', 'reported_for_app_id' => 'getReportedForAppId', - 'event_message' => 'getEventMessage', + 'event_message' => 'getEventMessage' ]; /** @@ -238,6 +248,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -259,33 +270,34 @@ public function __construct(array $data = null) $this->setIfExists('event_message', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): EventCallbackRequestEventMetadata { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): EventCallbackRequestEventMetadata { /** @var EventCallbackRequestEventMetadata */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, EventCallbackRequestEventMetadata::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -302,7 +314,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -316,6 +330,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets related_signature_id * @@ -333,14 +348,14 @@ public function getRelatedSignatureId() * * @return self */ - public function setRelatedSignatureId(?string $related_signature_id) + public function setRelatedSignatureId($related_signature_id) { if (is_null($related_signature_id)) { array_push($this->openAPINullablesSetToNull, 'related_signature_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('related_signature_id', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -363,18 +378,18 @@ public function getReportedForAccountId() /** * Sets reported_for_account_id * - * @param string|null $reported_for_account_id account ID the event was reported for + * @param string|null $reported_for_account_id Account ID the event was reported for. * * @return self */ - public function setReportedForAccountId(?string $reported_for_account_id) + public function setReportedForAccountId($reported_for_account_id) { if (is_null($reported_for_account_id)) { array_push($this->openAPINullablesSetToNull, 'reported_for_account_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('reported_for_account_id', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -397,18 +412,18 @@ public function getReportedForAppId() /** * Sets reported_for_app_id * - * @param string|null $reported_for_app_id app ID the event was reported for + * @param string|null $reported_for_app_id App ID the event was reported for. * * @return self */ - public function setReportedForAppId(?string $reported_for_app_id) + public function setReportedForAppId($reported_for_app_id) { if (is_null($reported_for_app_id)) { array_push($this->openAPINullablesSetToNull, 'reported_for_app_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('reported_for_app_id', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -431,18 +446,18 @@ public function getEventMessage() /** * Sets event_message * - * @param string|null $event_message message about a declined or failed (due to error) signature flow + * @param string|null $event_message Message about a declined or failed (due to error) signature flow. * * @return self */ - public function setEventMessage(?string $event_message) + public function setEventMessage($event_message) { if (is_null($event_message)) { array_push($this->openAPINullablesSetToNull, 'event_message'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('event_message', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -451,13 +466,14 @@ public function setEventMessage(?string $event_message) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -466,11 +482,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -481,8 +497,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -495,9 +513,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -505,15 +525,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -539,3 +559,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxGetResponse.php b/sdks/php/src/Model/FaxGetResponse.php index 232943492..8a620303e 100644 --- a/sdks/php/src/Model/FaxGetResponse.php +++ b/sdks/php/src/Model/FaxGetResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxGetResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxGetResponse implements ModelInterface, ArrayAccess, JsonSerializable +class FaxGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'fax' => '\Dropbox\Sign\Model\FaxResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'fax' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'fax' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'fax' => 'fax', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'fax' => 'setFax', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'fax' => 'getFax', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxGetResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxGetResponse { /** @var FaxGetResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxGetResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets fax * - * @return FaxResponse + * @return \Dropbox\Sign\Model\FaxResponse */ public function getFax() { @@ -320,14 +332,14 @@ public function getFax() /** * Sets fax * - * @param FaxResponse $fax fax + * @param \Dropbox\Sign\Model\FaxResponse $fax fax * * @return self */ - public function setFax(FaxResponse $fax) + public function setFax($fax) { if (is_null($fax)) { - throw new InvalidArgumentException('non-nullable fax cannot be null'); + throw new \InvalidArgumentException('non-nullable fax cannot be null'); } $this->container['fax'] = $fax; @@ -337,7 +349,7 @@ public function setFax(FaxResponse $fax) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxLineAddUserRequest.php b/sdks/php/src/Model/FaxLineAddUserRequest.php index b7e2c849a..ef7386518 100644 --- a/sdks/php/src/Model/FaxLineAddUserRequest.php +++ b/sdks/php/src/Model/FaxLineAddUserRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineAddUserRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineAddUserRequest implements ModelInterface, ArrayAccess, JsonSerializable +class FaxLineAddUserRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineAddUserRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'number' => 'string', 'account_id' => 'string', - 'email_address' => 'string', + 'email_address' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'number' => null, 'account_id' => null, - 'email_address' => 'email', + 'email_address' => 'email' ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'number' => false, 'account_id' => false, - 'email_address' => false, + 'email_address' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'number' => 'number', 'account_id' => 'account_id', - 'email_address' => 'email_address', + 'email_address' => 'email_address' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'number' => 'setNumber', 'account_id' => 'setAccountId', - 'email_address' => 'setEmailAddress', + 'email_address' => 'setEmailAddress' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'number' => 'getNumber', 'account_id' => 'getAccountId', - 'email_address' => 'getEmailAddress', + 'email_address' => 'getEmailAddress' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxLineAddUserRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxLineAddUserRequest { /** @var FaxLineAddUserRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxLineAddUserRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,6 +325,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets number * @@ -327,14 +339,14 @@ public function getNumber() /** * Sets number * - * @param string $number the Fax Line number + * @param string $number The Fax Line number * * @return self */ - public function setNumber(string $number) + public function setNumber($number) { if (is_null($number)) { - throw new InvalidArgumentException('non-nullable number cannot be null'); + throw new \InvalidArgumentException('non-nullable number cannot be null'); } $this->container['number'] = $number; @@ -358,10 +370,10 @@ public function getAccountId() * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -385,22 +397,23 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -409,11 +422,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -424,8 +437,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -438,9 +453,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -448,15 +465,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -482,3 +499,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxLineAreaCodeGetCountryEnum.php b/sdks/php/src/Model/FaxLineAreaCodeGetCountryEnum.php index 1b96f68c7..32842a253 100644 --- a/sdks/php/src/Model/FaxLineAreaCodeGetCountryEnum.php +++ b/sdks/php/src/Model/FaxLineAreaCodeGetCountryEnum.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,12 +28,15 @@ */ namespace Dropbox\Sign\Model; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineAreaCodeGetCountryEnum Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class FaxLineAreaCodeGetCountryEnum { @@ -53,7 +58,9 @@ public static function getAllowableEnumValues() return [ self::CA, self::US, - self::UK, + self::UK ]; } } + + diff --git a/sdks/php/src/Model/FaxLineAreaCodeGetProvinceEnum.php b/sdks/php/src/Model/FaxLineAreaCodeGetProvinceEnum.php index 8bfde8747..96bfaa35f 100644 --- a/sdks/php/src/Model/FaxLineAreaCodeGetProvinceEnum.php +++ b/sdks/php/src/Model/FaxLineAreaCodeGetProvinceEnum.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,12 +28,15 @@ */ namespace Dropbox\Sign\Model; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineAreaCodeGetProvinceEnum Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class FaxLineAreaCodeGetProvinceEnum { @@ -83,7 +88,9 @@ public static function getAllowableEnumValues() self::PE, self::QC, self::SK, - self::YT, + self::YT ]; } } + + diff --git a/sdks/php/src/Model/FaxLineAreaCodeGetResponse.php b/sdks/php/src/Model/FaxLineAreaCodeGetResponse.php index 085e8a8e3..31223bc13 100644 --- a/sdks/php/src/Model/FaxLineAreaCodeGetResponse.php +++ b/sdks/php/src/Model/FaxLineAreaCodeGetResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineAreaCodeGetResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineAreaCodeGetResponse implements ModelInterface, ArrayAccess, JsonSerializable +class FaxLineAreaCodeGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineAreaCodeGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'area_codes' => 'int[]', + 'area_codes' => 'int[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'area_codes' => null, + 'area_codes' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'area_codes' => false, + 'area_codes' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'area_codes' => 'area_codes', + 'area_codes' => 'area_codes' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'area_codes' => 'setAreaCodes', + 'area_codes' => 'setAreaCodes' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'area_codes' => 'getAreaCodes', + 'area_codes' => 'getAreaCodes' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('area_codes', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxLineAreaCodeGetResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxLineAreaCodeGetResponse { /** @var FaxLineAreaCodeGetResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxLineAreaCodeGetResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,6 +311,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets area_codes * @@ -317,22 +329,23 @@ public function getAreaCodes() * * @return self */ - public function setAreaCodes(array $area_codes) + public function setAreaCodes($area_codes) { if (is_null($area_codes)) { - throw new InvalidArgumentException('non-nullable area_codes cannot be null'); + throw new \InvalidArgumentException('non-nullable area_codes cannot be null'); } $this->container['area_codes'] = $area_codes; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -341,11 +354,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -356,8 +369,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -370,9 +385,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -380,15 +397,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -414,3 +431,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxLineAreaCodeGetStateEnum.php b/sdks/php/src/Model/FaxLineAreaCodeGetStateEnum.php index db4f35fd0..4e688a545 100644 --- a/sdks/php/src/Model/FaxLineAreaCodeGetStateEnum.php +++ b/sdks/php/src/Model/FaxLineAreaCodeGetStateEnum.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,12 +28,15 @@ */ namespace Dropbox\Sign\Model; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineAreaCodeGetStateEnum Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class FaxLineAreaCodeGetStateEnum { @@ -197,7 +202,9 @@ public static function getAllowableEnumValues() self::WA, self::WI, self::WV, - self::WY, + self::WY ]; } } + + diff --git a/sdks/php/src/Model/FaxLineCreateRequest.php b/sdks/php/src/Model/FaxLineCreateRequest.php index a898fef9d..22bd01cd0 100644 --- a/sdks/php/src/Model/FaxLineCreateRequest.php +++ b/sdks/php/src/Model/FaxLineCreateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineCreateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class FaxLineCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'area_code' => 'int', 'country' => 'string', 'city' => 'string', - 'account_id' => 'string', + 'account_id' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'area_code' => null, 'country' => null, 'city' => null, - 'account_id' => null, + 'account_id' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'area_code' => false, 'country' => false, 'city' => false, - 'account_id' => false, + 'account_id' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'area_code' => 'area_code', 'country' => 'country', 'city' => 'city', - 'account_id' => 'account_id', + 'account_id' => 'account_id' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'area_code' => 'setAreaCode', 'country' => 'setCountry', 'city' => 'setCity', - 'account_id' => 'setAccountId', + 'account_id' => 'setAccountId' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'area_code' => 'getAreaCode', 'country' => 'getCountry', 'city' => 'getCity', - 'account_id' => 'getAccountId', + 'account_id' => 'getAccountId' ]; /** @@ -277,33 +286,34 @@ public function __construct(array $data = null) $this->setIfExists('account_id', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxLineCreateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxLineCreateRequest { /** @var FaxLineCreateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxLineCreateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -351,6 +361,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets area_code * @@ -364,14 +375,14 @@ public function getAreaCode() /** * Sets area_code * - * @param int $area_code Area code + * @param int $area_code Area code of the new Fax Line * * @return self */ - public function setAreaCode(int $area_code) + public function setAreaCode($area_code) { if (is_null($area_code)) { - throw new InvalidArgumentException('non-nullable area_code cannot be null'); + throw new \InvalidArgumentException('non-nullable area_code cannot be null'); } $this->container['area_code'] = $area_code; @@ -391,18 +402,18 @@ public function getCountry() /** * Sets country * - * @param string $country Country + * @param string $country Country of the area code * * @return self */ - public function setCountry(string $country) + public function setCountry($country) { if (is_null($country)) { - throw new InvalidArgumentException('non-nullable country cannot be null'); + throw new \InvalidArgumentException('non-nullable country cannot be null'); } $allowedValues = $this->getCountryAllowableValues(); if (!in_array($country, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'country', must be one of '%s'", $country, @@ -428,14 +439,14 @@ public function getCity() /** * Sets city * - * @param string|null $city City + * @param string|null $city City of the area code * * @return self */ - public function setCity(?string $city) + public function setCity($city) { if (is_null($city)) { - throw new InvalidArgumentException('non-nullable city cannot be null'); + throw new \InvalidArgumentException('non-nullable city cannot be null'); } $this->container['city'] = $city; @@ -455,26 +466,27 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id Account ID + * @param string|null $account_id Account ID of the account that will be assigned this new Fax Line * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -483,11 +495,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -498,8 +510,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -512,9 +526,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -522,15 +538,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -556,3 +572,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxLineDeleteRequest.php b/sdks/php/src/Model/FaxLineDeleteRequest.php index 1fc4fa4a6..cc8b60a20 100644 --- a/sdks/php/src/Model/FaxLineDeleteRequest.php +++ b/sdks/php/src/Model/FaxLineDeleteRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineDeleteRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineDeleteRequest implements ModelInterface, ArrayAccess, JsonSerializable +class FaxLineDeleteRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineDeleteRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'number' => 'string', + 'number' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'number' => null, + 'number' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'number' => false, + 'number' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'number' => 'number', + 'number' => 'number' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'number' => 'setNumber', + 'number' => 'setNumber' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'number' => 'getNumber', + 'number' => 'getNumber' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('number', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxLineDeleteRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxLineDeleteRequest { /** @var FaxLineDeleteRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxLineDeleteRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,6 +311,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets number * @@ -313,26 +325,27 @@ public function getNumber() /** * Sets number * - * @param string $number the Fax Line number + * @param string $number The Fax Line number * * @return self */ - public function setNumber(string $number) + public function setNumber($number) { if (is_null($number)) { - throw new InvalidArgumentException('non-nullable number cannot be null'); + throw new \InvalidArgumentException('non-nullable number cannot be null'); } $this->container['number'] = $number; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -341,11 +354,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -356,8 +369,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -370,9 +385,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -380,15 +397,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -414,3 +431,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxLineListResponse.php b/sdks/php/src/Model/FaxLineListResponse.php index 1b32ad49c..c724e50f8 100644 --- a/sdks/php/src/Model/FaxLineListResponse.php +++ b/sdks/php/src/Model/FaxLineListResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineListResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineListResponse implements ModelInterface, ArrayAccess, JsonSerializable +class FaxLineListResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', 'fax_lines' => '\Dropbox\Sign\Model\FaxLineResponseFaxLine[]', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'list_info' => null, 'fax_lines' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'list_info' => false, 'fax_lines' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'list_info' => 'list_info', 'fax_lines' => 'fax_lines', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'list_info' => 'setListInfo', 'fax_lines' => 'setFaxLines', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'list_info' => 'getListInfo', 'fax_lines' => 'getFaxLines', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxLineListResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxLineListResponse { /** @var FaxLineListResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxLineListResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,10 +328,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets list_info * - * @return ListInfoResponse + * @return \Dropbox\Sign\Model\ListInfoResponse */ public function getListInfo() { @@ -330,14 +342,14 @@ public function getListInfo() /** * Sets list_info * - * @param ListInfoResponse $list_info list_info + * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo(ListInfoResponse $list_info) + public function setListInfo($list_info) { if (is_null($list_info)) { - throw new InvalidArgumentException('non-nullable list_info cannot be null'); + throw new \InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -347,7 +359,7 @@ public function setListInfo(ListInfoResponse $list_info) /** * Gets fax_lines * - * @return FaxLineResponseFaxLine[] + * @return \Dropbox\Sign\Model\FaxLineResponseFaxLine[] */ public function getFaxLines() { @@ -357,14 +369,14 @@ public function getFaxLines() /** * Sets fax_lines * - * @param FaxLineResponseFaxLine[] $fax_lines fax_lines + * @param \Dropbox\Sign\Model\FaxLineResponseFaxLine[] $fax_lines fax_lines * * @return self */ - public function setFaxLines(array $fax_lines) + public function setFaxLines($fax_lines) { if (is_null($fax_lines)) { - throw new InvalidArgumentException('non-nullable fax_lines cannot be null'); + throw new \InvalidArgumentException('non-nullable fax_lines cannot be null'); } $this->container['fax_lines'] = $fax_lines; @@ -374,7 +386,7 @@ public function setFaxLines(array $fax_lines) /** * Gets warnings * - * @return WarningResponse|null + * @return \Dropbox\Sign\Model\WarningResponse|null */ public function getWarnings() { @@ -384,26 +396,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse|null $warnings warnings + * @param \Dropbox\Sign\Model\WarningResponse|null $warnings warnings * * @return self */ - public function setWarnings(?WarningResponse $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -412,11 +425,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -427,8 +440,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -441,9 +456,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -451,15 +468,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -485,3 +502,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxLineRemoveUserRequest.php b/sdks/php/src/Model/FaxLineRemoveUserRequest.php index 5bec49060..127972e3f 100644 --- a/sdks/php/src/Model/FaxLineRemoveUserRequest.php +++ b/sdks/php/src/Model/FaxLineRemoveUserRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineRemoveUserRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineRemoveUserRequest implements ModelInterface, ArrayAccess, JsonSerializable +class FaxLineRemoveUserRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineRemoveUserRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'number' => 'string', 'account_id' => 'string', - 'email_address' => 'string', + 'email_address' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'number' => null, 'account_id' => null, - 'email_address' => 'email', + 'email_address' => 'email' ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'number' => false, 'account_id' => false, - 'email_address' => false, + 'email_address' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'number' => 'number', 'account_id' => 'account_id', - 'email_address' => 'email_address', + 'email_address' => 'email_address' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'number' => 'setNumber', 'account_id' => 'setAccountId', - 'email_address' => 'setEmailAddress', + 'email_address' => 'setEmailAddress' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'number' => 'getNumber', 'account_id' => 'getAccountId', - 'email_address' => 'getEmailAddress', + 'email_address' => 'getEmailAddress' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxLineRemoveUserRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxLineRemoveUserRequest { /** @var FaxLineRemoveUserRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxLineRemoveUserRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,6 +325,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets number * @@ -327,14 +339,14 @@ public function getNumber() /** * Sets number * - * @param string $number the Fax Line number + * @param string $number The Fax Line number * * @return self */ - public function setNumber(string $number) + public function setNumber($number) { if (is_null($number)) { - throw new InvalidArgumentException('non-nullable number cannot be null'); + throw new \InvalidArgumentException('non-nullable number cannot be null'); } $this->container['number'] = $number; @@ -354,14 +366,14 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id Account ID + * @param string|null $account_id Account ID of the user to remove access * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -381,26 +393,27 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address Email address + * @param string|null $email_address Email address of the user to remove access * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -409,11 +422,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -424,8 +437,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -438,9 +453,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -448,15 +465,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -482,3 +499,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxLineResponse.php b/sdks/php/src/Model/FaxLineResponse.php index c30616f6c..ae2219f3a 100644 --- a/sdks/php/src/Model/FaxLineResponse.php +++ b/sdks/php/src/Model/FaxLineResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineResponse implements ModelInterface, ArrayAccess, JsonSerializable +class FaxLineResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'fax_line' => '\Dropbox\Sign\Model\FaxLineResponseFaxLine', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'fax_line' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'fax_line' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'fax_line' => 'fax_line', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'fax_line' => 'setFaxLine', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'fax_line' => 'getFaxLine', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxLineResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxLineResponse { /** @var FaxLineResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxLineResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets fax_line * - * @return FaxLineResponseFaxLine + * @return \Dropbox\Sign\Model\FaxLineResponseFaxLine */ public function getFaxLine() { @@ -320,14 +332,14 @@ public function getFaxLine() /** * Sets fax_line * - * @param FaxLineResponseFaxLine $fax_line fax_line + * @param \Dropbox\Sign\Model\FaxLineResponseFaxLine $fax_line fax_line * * @return self */ - public function setFaxLine(FaxLineResponseFaxLine $fax_line) + public function setFaxLine($fax_line) { if (is_null($fax_line)) { - throw new InvalidArgumentException('non-nullable fax_line cannot be null'); + throw new \InvalidArgumentException('non-nullable fax_line cannot be null'); } $this->container['fax_line'] = $fax_line; @@ -337,7 +349,7 @@ public function setFaxLine(FaxLineResponseFaxLine $fax_line) /** * Gets warnings * - * @return WarningResponse|null + * @return \Dropbox\Sign\Model\WarningResponse|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse|null $warnings warnings + * @param \Dropbox\Sign\Model\WarningResponse|null $warnings warnings * * @return self */ - public function setWarnings(?WarningResponse $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxLineResponseFaxLine.php b/sdks/php/src/Model/FaxLineResponseFaxLine.php index 4a3fe8fa7..ccb938b82 100644 --- a/sdks/php/src/Model/FaxLineResponseFaxLine.php +++ b/sdks/php/src/Model/FaxLineResponseFaxLine.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxLineResponseFaxLine Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineResponseFaxLine implements ModelInterface, ArrayAccess, JsonSerializable +class FaxLineResponseFaxLine implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineResponseFaxLine'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'number' => 'string', 'created_at' => 'int', 'updated_at' => 'int', - 'accounts' => '\Dropbox\Sign\Model\AccountResponse[]', + 'accounts' => '\Dropbox\Sign\Model\AccountResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'number' => null, 'created_at' => null, 'updated_at' => null, - 'accounts' => null, + 'accounts' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'number' => false, 'created_at' => false, 'updated_at' => false, - 'accounts' => false, + 'accounts' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'number' => 'number', 'created_at' => 'created_at', 'updated_at' => 'updated_at', - 'accounts' => 'accounts', + 'accounts' => 'accounts' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'number' => 'setNumber', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', - 'accounts' => 'setAccounts', + 'accounts' => 'setAccounts' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'number' => 'getNumber', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', - 'accounts' => 'getAccounts', + 'accounts' => 'getAccounts' ]; /** @@ -238,6 +247,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -259,33 +269,34 @@ public function __construct(array $data = null) $this->setIfExists('accounts', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxLineResponseFaxLine { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxLineResponseFaxLine { /** @var FaxLineResponseFaxLine */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxLineResponseFaxLine::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -302,7 +313,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -316,6 +329,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets number * @@ -333,10 +347,10 @@ public function getNumber() * * @return self */ - public function setNumber(?string $number) + public function setNumber($number) { if (is_null($number)) { - throw new InvalidArgumentException('non-nullable number cannot be null'); + throw new \InvalidArgumentException('non-nullable number cannot be null'); } $this->container['number'] = $number; @@ -360,10 +374,10 @@ public function getCreatedAt() * * @return self */ - public function setCreatedAt(?int $created_at) + public function setCreatedAt($created_at) { if (is_null($created_at)) { - throw new InvalidArgumentException('non-nullable created_at cannot be null'); + throw new \InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; @@ -387,10 +401,10 @@ public function getUpdatedAt() * * @return self */ - public function setUpdatedAt(?int $updated_at) + public function setUpdatedAt($updated_at) { if (is_null($updated_at)) { - throw new InvalidArgumentException('non-nullable updated_at cannot be null'); + throw new \InvalidArgumentException('non-nullable updated_at cannot be null'); } $this->container['updated_at'] = $updated_at; @@ -400,7 +414,7 @@ public function setUpdatedAt(?int $updated_at) /** * Gets accounts * - * @return AccountResponse[]|null + * @return \Dropbox\Sign\Model\AccountResponse[]|null */ public function getAccounts() { @@ -410,26 +424,27 @@ public function getAccounts() /** * Sets accounts * - * @param AccountResponse[]|null $accounts accounts + * @param \Dropbox\Sign\Model\AccountResponse[]|null $accounts accounts * * @return self */ - public function setAccounts(?array $accounts) + public function setAccounts($accounts) { if (is_null($accounts)) { - throw new InvalidArgumentException('non-nullable accounts cannot be null'); + throw new \InvalidArgumentException('non-nullable accounts cannot be null'); } $this->container['accounts'] = $accounts; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -438,11 +453,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -453,8 +468,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -467,9 +484,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -477,15 +496,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -511,3 +530,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxListResponse.php b/sdks/php/src/Model/FaxListResponse.php index 21e89d342..f3977d065 100644 --- a/sdks/php/src/Model/FaxListResponse.php +++ b/sdks/php/src/Model/FaxListResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxListResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxListResponse implements ModelInterface, ArrayAccess, JsonSerializable +class FaxListResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'faxes' => '\Dropbox\Sign\Model\FaxResponse[]', - 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', + 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'faxes' => null, - 'list_info' => null, + 'list_info' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'faxes' => false, - 'list_info' => false, + 'list_info' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'faxes' => 'faxes', - 'list_info' => 'list_info', + 'list_info' => 'list_info' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'faxes' => 'setFaxes', - 'list_info' => 'setListInfo', + 'list_info' => 'setListInfo' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'faxes' => 'getFaxes', - 'list_info' => 'getListInfo', + 'list_info' => 'getListInfo' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('list_info', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxListResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxListResponse { /** @var FaxListResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxListResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -310,10 +321,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets faxes * - * @return FaxResponse[] + * @return \Dropbox\Sign\Model\FaxResponse[] */ public function getFaxes() { @@ -323,14 +335,14 @@ public function getFaxes() /** * Sets faxes * - * @param FaxResponse[] $faxes faxes + * @param \Dropbox\Sign\Model\FaxResponse[] $faxes faxes * * @return self */ - public function setFaxes(array $faxes) + public function setFaxes($faxes) { if (is_null($faxes)) { - throw new InvalidArgumentException('non-nullable faxes cannot be null'); + throw new \InvalidArgumentException('non-nullable faxes cannot be null'); } $this->container['faxes'] = $faxes; @@ -340,7 +352,7 @@ public function setFaxes(array $faxes) /** * Gets list_info * - * @return ListInfoResponse + * @return \Dropbox\Sign\Model\ListInfoResponse */ public function getListInfo() { @@ -350,26 +362,27 @@ public function getListInfo() /** * Sets list_info * - * @param ListInfoResponse $list_info list_info + * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo(ListInfoResponse $list_info) + public function setListInfo($list_info) { if (is_null($list_info)) { - throw new InvalidArgumentException('non-nullable list_info cannot be null'); + throw new \InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -378,11 +391,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -393,8 +406,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -407,9 +422,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -417,15 +434,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -451,3 +468,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxResponse.php b/sdks/php/src/Model/FaxResponse.php index 9471ccc8a..c9688e9f5 100644 --- a/sdks/php/src/Model/FaxResponse.php +++ b/sdks/php/src/Model/FaxResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,35 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxResponse implements ModelInterface, ArrayAccess, JsonSerializable +class FaxResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'fax_id' => 'string', 'title' => 'string', @@ -67,16 +68,16 @@ class FaxResponse implements ModelInterface, ArrayAccess, JsonSerializable 'transmissions' => '\Dropbox\Sign\Model\FaxResponseTransmission[]', 'subject' => 'string', 'message' => 'string', - 'final_copy_uri' => 'string', + 'final_copy_uri' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'fax_id' => null, 'title' => null, @@ -88,14 +89,14 @@ class FaxResponse implements ModelInterface, ArrayAccess, JsonSerializable 'transmissions' => null, 'subject' => null, 'message' => null, - 'final_copy_uri' => null, + 'final_copy_uri' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'fax_id' => false, 'title' => false, @@ -107,14 +108,14 @@ class FaxResponse implements ModelInterface, ArrayAccess, JsonSerializable 'transmissions' => false, 'subject' => true, 'message' => true, - 'final_copy_uri' => true, + 'final_copy_uri' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -139,6 +140,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -148,7 +151,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -158,7 +161,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -167,6 +170,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -175,6 +181,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -198,7 +207,7 @@ public function isNullableSetToNull(string $property): bool 'transmissions' => 'transmissions', 'subject' => 'subject', 'message' => 'message', - 'final_copy_uri' => 'final_copy_uri', + 'final_copy_uri' => 'final_copy_uri' ]; /** @@ -217,7 +226,7 @@ public function isNullableSetToNull(string $property): bool 'transmissions' => 'setTransmissions', 'subject' => 'setSubject', 'message' => 'setMessage', - 'final_copy_uri' => 'setFinalCopyUri', + 'final_copy_uri' => 'setFinalCopyUri' ]; /** @@ -236,7 +245,7 @@ public function isNullableSetToNull(string $property): bool 'transmissions' => 'getTransmissions', 'subject' => 'getSubject', 'message' => 'getMessage', - 'final_copy_uri' => 'getFinalCopyUri', + 'final_copy_uri' => 'getFinalCopyUri' ]; /** @@ -280,6 +289,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -308,33 +318,34 @@ public function __construct(array $data = null) $this->setIfExists('final_copy_uri', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxResponse { /** @var FaxResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -391,6 +402,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets fax_id * @@ -408,10 +420,10 @@ public function getFaxId() * * @return self */ - public function setFaxId(string $fax_id) + public function setFaxId($fax_id) { if (is_null($fax_id)) { - throw new InvalidArgumentException('non-nullable fax_id cannot be null'); + throw new \InvalidArgumentException('non-nullable fax_id cannot be null'); } $this->container['fax_id'] = $fax_id; @@ -435,10 +447,10 @@ public function getTitle() * * @return self */ - public function setTitle(string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -462,10 +474,10 @@ public function getOriginalTitle() * * @return self */ - public function setOriginalTitle(string $original_title) + public function setOriginalTitle($original_title) { if (is_null($original_title)) { - throw new InvalidArgumentException('non-nullable original_title cannot be null'); + throw new \InvalidArgumentException('non-nullable original_title cannot be null'); } $this->container['original_title'] = $original_title; @@ -489,10 +501,10 @@ public function getMetadata() * * @return self */ - public function setMetadata(array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } $this->container['metadata'] = $metadata; @@ -516,10 +528,10 @@ public function getCreatedAt() * * @return self */ - public function setCreatedAt(int $created_at) + public function setCreatedAt($created_at) { if (is_null($created_at)) { - throw new InvalidArgumentException('non-nullable created_at cannot be null'); + throw new \InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; @@ -543,10 +555,10 @@ public function getSender() * * @return self */ - public function setSender(string $sender) + public function setSender($sender) { if (is_null($sender)) { - throw new InvalidArgumentException('non-nullable sender cannot be null'); + throw new \InvalidArgumentException('non-nullable sender cannot be null'); } $this->container['sender'] = $sender; @@ -570,10 +582,10 @@ public function getFilesUrl() * * @return self */ - public function setFilesUrl(string $files_url) + public function setFilesUrl($files_url) { if (is_null($files_url)) { - throw new InvalidArgumentException('non-nullable files_url cannot be null'); + throw new \InvalidArgumentException('non-nullable files_url cannot be null'); } $this->container['files_url'] = $files_url; @@ -583,7 +595,7 @@ public function setFilesUrl(string $files_url) /** * Gets transmissions * - * @return FaxResponseTransmission[] + * @return \Dropbox\Sign\Model\FaxResponseTransmission[] */ public function getTransmissions() { @@ -593,14 +605,14 @@ public function getTransmissions() /** * Sets transmissions * - * @param FaxResponseTransmission[] $transmissions Fax Transmissions List + * @param \Dropbox\Sign\Model\FaxResponseTransmission[] $transmissions Fax Transmissions List * * @return self */ - public function setTransmissions(array $transmissions) + public function setTransmissions($transmissions) { if (is_null($transmissions)) { - throw new InvalidArgumentException('non-nullable transmissions cannot be null'); + throw new \InvalidArgumentException('non-nullable transmissions cannot be null'); } $this->container['transmissions'] = $transmissions; @@ -624,14 +636,14 @@ public function getSubject() * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { array_push($this->openAPINullablesSetToNull, 'subject'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('subject', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -658,14 +670,14 @@ public function getMessage() * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { array_push($this->openAPINullablesSetToNull, 'message'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('message', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -692,14 +704,14 @@ public function getFinalCopyUri() * * @return self */ - public function setFinalCopyUri(?string $final_copy_uri) + public function setFinalCopyUri($final_copy_uri) { if (is_null($final_copy_uri)) { array_push($this->openAPINullablesSetToNull, 'final_copy_uri'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('final_copy_uri', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -708,13 +720,14 @@ public function setFinalCopyUri(?string $final_copy_uri) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -723,11 +736,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -738,8 +751,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -752,9 +767,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -762,15 +779,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -796,3 +813,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxResponseTransmission.php b/sdks/php/src/Model/FaxResponseTransmission.php index 8c30b8ad5..9afeb1d1a 100644 --- a/sdks/php/src/Model/FaxResponseTransmission.php +++ b/sdks/php/src/Model/FaxResponseTransmission.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxResponseTransmission Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxResponseTransmission implements ModelInterface, ArrayAccess, JsonSerializable +class FaxResponseTransmission implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxResponseTransmission'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'recipient' => 'string', 'status_code' => 'string', - 'sent_at' => 'int', + 'sent_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'recipient' => null, 'status_code' => null, - 'sent_at' => null, + 'sent_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'recipient' => false, 'status_code' => false, - 'sent_at' => false, + 'sent_at' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'recipient' => 'recipient', 'status_code' => 'status_code', - 'sent_at' => 'sent_at', + 'sent_at' => 'sent_at' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'recipient' => 'setRecipient', 'status_code' => 'setStatusCode', - 'sent_at' => 'setSentAt', + 'sent_at' => 'setSentAt' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'recipient' => 'getRecipient', 'status_code' => 'getStatusCode', - 'sent_at' => 'getSentAt', + 'sent_at' => 'getSentAt' ]; /** @@ -280,33 +289,34 @@ public function __construct(array $data = null) $this->setIfExists('sent_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxResponseTransmission { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxResponseTransmission { /** @var FaxResponseTransmission */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxResponseTransmission::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -354,6 +364,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets recipient * @@ -371,10 +382,10 @@ public function getRecipient() * * @return self */ - public function setRecipient(string $recipient) + public function setRecipient($recipient) { if (is_null($recipient)) { - throw new InvalidArgumentException('non-nullable recipient cannot be null'); + throw new \InvalidArgumentException('non-nullable recipient cannot be null'); } $this->container['recipient'] = $recipient; @@ -398,14 +409,14 @@ public function getStatusCode() * * @return self */ - public function setStatusCode(string $status_code) + public function setStatusCode($status_code) { if (is_null($status_code)) { - throw new InvalidArgumentException('non-nullable status_code cannot be null'); + throw new \InvalidArgumentException('non-nullable status_code cannot be null'); } $allowedValues = $this->getStatusCodeAllowableValues(); if (!in_array($status_code, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'status_code', must be one of '%s'", $status_code, @@ -435,22 +446,23 @@ public function getSentAt() * * @return self */ - public function setSentAt(?int $sent_at) + public function setSentAt($sent_at) { if (is_null($sent_at)) { - throw new InvalidArgumentException('non-nullable sent_at cannot be null'); + throw new \InvalidArgumentException('non-nullable sent_at cannot be null'); } $this->container['sent_at'] = $sent_at; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -459,11 +471,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -474,8 +486,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -488,9 +502,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -498,15 +514,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -532,3 +548,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FaxSendRequest.php b/sdks/php/src/Model/FaxSendRequest.php index d09573478..bfd5e9dec 100644 --- a/sdks/php/src/Model/FaxSendRequest.php +++ b/sdks/php/src/Model/FaxSendRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FaxSendRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxSendRequest implements ModelInterface, ArrayAccess, JsonSerializable +class FaxSendRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxSendRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'recipient' => 'string', 'sender' => 'string', @@ -66,16 +66,16 @@ class FaxSendRequest implements ModelInterface, ArrayAccess, JsonSerializable 'cover_page_to' => 'string', 'cover_page_from' => 'string', 'cover_page_message' => 'string', - 'title' => 'string', + 'title' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'recipient' => null, 'sender' => null, @@ -85,14 +85,14 @@ class FaxSendRequest implements ModelInterface, ArrayAccess, JsonSerializable 'cover_page_to' => null, 'cover_page_from' => null, 'cover_page_message' => null, - 'title' => null, + 'title' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'recipient' => false, 'sender' => false, @@ -102,14 +102,14 @@ class FaxSendRequest implements ModelInterface, ArrayAccess, JsonSerializable 'cover_page_to' => false, 'cover_page_from' => false, 'cover_page_message' => false, - 'title' => false, + 'title' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -134,6 +134,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -143,7 +145,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -153,7 +155,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -162,6 +164,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -170,6 +175,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -191,7 +199,7 @@ public function isNullableSetToNull(string $property): bool 'cover_page_to' => 'cover_page_to', 'cover_page_from' => 'cover_page_from', 'cover_page_message' => 'cover_page_message', - 'title' => 'title', + 'title' => 'title' ]; /** @@ -208,7 +216,7 @@ public function isNullableSetToNull(string $property): bool 'cover_page_to' => 'setCoverPageTo', 'cover_page_from' => 'setCoverPageFrom', 'cover_page_message' => 'setCoverPageMessage', - 'title' => 'setTitle', + 'title' => 'setTitle' ]; /** @@ -225,7 +233,7 @@ public function isNullableSetToNull(string $property): bool 'cover_page_to' => 'getCoverPageTo', 'cover_page_from' => 'getCoverPageFrom', 'cover_page_message' => 'getCoverPageMessage', - 'title' => 'getTitle', + 'title' => 'getTitle' ]; /** @@ -269,6 +277,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -295,33 +304,34 @@ public function __construct(array $data = null) $this->setIfExists('title', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FaxSendRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FaxSendRequest { /** @var FaxSendRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FaxSendRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -357,6 +367,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets recipient * @@ -370,14 +381,14 @@ public function getRecipient() /** * Sets recipient * - * @param string $recipient Fax Send To Recipient + * @param string $recipient Recipient of the fax Can be a phone number in E.164 format or email address * * @return self */ - public function setRecipient(string $recipient) + public function setRecipient($recipient) { if (is_null($recipient)) { - throw new InvalidArgumentException('non-nullable recipient cannot be null'); + throw new \InvalidArgumentException('non-nullable recipient cannot be null'); } $this->container['recipient'] = $recipient; @@ -401,10 +412,10 @@ public function getSender() * * @return self */ - public function setSender(?string $sender) + public function setSender($sender) { if (is_null($sender)) { - throw new InvalidArgumentException('non-nullable sender cannot be null'); + throw new \InvalidArgumentException('non-nullable sender cannot be null'); } $this->container['sender'] = $sender; @@ -414,7 +425,7 @@ public function setSender(?string $sender) /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -424,14 +435,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Fax File to Send + * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -451,14 +462,14 @@ public function getFileUrls() /** * Sets file_urls * - * @param string[]|null $file_urls Fax File URL to Send + * @param string[]|null $file_urls Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -482,10 +493,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -505,14 +516,14 @@ public function getCoverPageTo() /** * Sets cover_page_to * - * @param string|null $cover_page_to Fax Cover Page for Recipient + * @param string|null $cover_page_to Fax cover page recipient information * * @return self */ - public function setCoverPageTo(?string $cover_page_to) + public function setCoverPageTo($cover_page_to) { if (is_null($cover_page_to)) { - throw new InvalidArgumentException('non-nullable cover_page_to cannot be null'); + throw new \InvalidArgumentException('non-nullable cover_page_to cannot be null'); } $this->container['cover_page_to'] = $cover_page_to; @@ -532,14 +543,14 @@ public function getCoverPageFrom() /** * Sets cover_page_from * - * @param string|null $cover_page_from Fax Cover Page for Sender + * @param string|null $cover_page_from Fax cover page sender information * * @return self */ - public function setCoverPageFrom(?string $cover_page_from) + public function setCoverPageFrom($cover_page_from) { if (is_null($cover_page_from)) { - throw new InvalidArgumentException('non-nullable cover_page_from cannot be null'); + throw new \InvalidArgumentException('non-nullable cover_page_from cannot be null'); } $this->container['cover_page_from'] = $cover_page_from; @@ -563,10 +574,10 @@ public function getCoverPageMessage() * * @return self */ - public function setCoverPageMessage(?string $cover_page_message) + public function setCoverPageMessage($cover_page_message) { if (is_null($cover_page_message)) { - throw new InvalidArgumentException('non-nullable cover_page_message cannot be null'); + throw new \InvalidArgumentException('non-nullable cover_page_message cannot be null'); } $this->container['cover_page_message'] = $cover_page_message; @@ -590,22 +601,23 @@ public function getTitle() * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -614,11 +626,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -629,8 +641,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -643,9 +657,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -653,15 +669,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -687,3 +703,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FileResponse.php b/sdks/php/src/Model/FileResponse.php index 3ebdc3378..0abdabe17 100644 --- a/sdks/php/src/Model/FileResponse.php +++ b/sdks/php/src/Model/FileResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FileResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FileResponse implements ModelInterface, ArrayAccess, JsonSerializable +class FileResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FileResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'file_url' => 'string', - 'expires_at' => 'int', + 'expires_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'file_url' => null, - 'expires_at' => null, + 'expires_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'file_url' => false, - 'expires_at' => false, + 'expires_at' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'file_url' => 'file_url', - 'expires_at' => 'expires_at', + 'expires_at' => 'expires_at' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'file_url' => 'setFileUrl', - 'expires_at' => 'setExpiresAt', + 'expires_at' => 'setExpiresAt' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'file_url' => 'getFileUrl', - 'expires_at' => 'getExpiresAt', + 'expires_at' => 'getExpiresAt' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FileResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FileResponse { /** @var FileResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FileResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -310,6 +321,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets file_url * @@ -323,14 +335,14 @@ public function getFileUrl() /** * Sets file_url * - * @param string $file_url URL to the file + * @param string $file_url URL to the file. * * @return self */ - public function setFileUrl(string $file_url) + public function setFileUrl($file_url) { if (is_null($file_url)) { - throw new InvalidArgumentException('non-nullable file_url cannot be null'); + throw new \InvalidArgumentException('non-nullable file_url cannot be null'); } $this->container['file_url'] = $file_url; @@ -350,26 +362,27 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int $expires_at when the link expires + * @param int $expires_at When the link expires. * * @return self */ - public function setExpiresAt(int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { - throw new InvalidArgumentException('non-nullable expires_at cannot be null'); + throw new \InvalidArgumentException('non-nullable expires_at cannot be null'); } $this->container['expires_at'] = $expires_at; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -378,11 +391,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -393,8 +406,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -407,9 +422,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -417,15 +434,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -451,3 +468,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/FileResponseDataUri.php b/sdks/php/src/Model/FileResponseDataUri.php index 474e8a73d..86a0e0284 100644 --- a/sdks/php/src/Model/FileResponseDataUri.php +++ b/sdks/php/src/Model/FileResponseDataUri.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * FileResponseDataUri Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class FileResponseDataUri implements ModelInterface, ArrayAccess, JsonSerializable +class FileResponseDataUri implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FileResponseDataUri'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'data_uri' => 'string', + 'data_uri' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'data_uri' => null, + 'data_uri' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'data_uri' => false, + 'data_uri' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'data_uri' => 'data_uri', + 'data_uri' => 'data_uri' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'data_uri' => 'setDataUri', + 'data_uri' => 'setDataUri' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'data_uri' => 'getDataUri', + 'data_uri' => 'getDataUri' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('data_uri', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): FileResponseDataUri { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): FileResponseDataUri { /** @var FileResponseDataUri */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, FileResponseDataUri::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,6 +311,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets data_uri * @@ -313,26 +325,27 @@ public function getDataUri() /** * Sets data_uri * - * @param string $data_uri file as base64 encoded string + * @param string $data_uri File as base64 encoded string. * * @return self */ - public function setDataUri(string $data_uri) + public function setDataUri($data_uri) { if (is_null($data_uri)) { - throw new InvalidArgumentException('non-nullable data_uri cannot be null'); + throw new \InvalidArgumentException('non-nullable data_uri cannot be null'); } $this->container['data_uri'] = $data_uri; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -341,11 +354,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -356,8 +369,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -370,9 +385,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -380,15 +397,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -414,3 +431,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ListInfoResponse.php b/sdks/php/src/Model/ListInfoResponse.php index 623284e41..dffd8eacb 100644 --- a/sdks/php/src/Model/ListInfoResponse.php +++ b/sdks/php/src/Model/ListInfoResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,74 +29,73 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ListInfoResponse Class Doc Comment * * @category Class * @description Contains pagination information about the data returned. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ListInfoResponse implements ModelInterface, ArrayAccess, JsonSerializable +class ListInfoResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ListInfoResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'num_pages' => 'int', 'num_results' => 'int', 'page' => 'int', - 'page_size' => 'int', + 'page_size' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'num_pages' => null, 'num_results' => null, 'page' => null, - 'page_size' => null, + 'page_size' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'num_pages' => false, 'num_results' => true, 'page' => false, - 'page_size' => false, + 'page_size' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,6 +120,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -128,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -138,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -147,6 +150,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -155,6 +161,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool 'num_pages' => 'num_pages', 'num_results' => 'num_results', 'page' => 'page', - 'page_size' => 'page_size', + 'page_size' => 'page_size' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'num_pages' => 'setNumPages', 'num_results' => 'setNumResults', 'page' => 'setPage', - 'page_size' => 'setPageSize', + 'page_size' => 'setPageSize' ]; /** @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'num_pages' => 'getNumPages', 'num_results' => 'getNumResults', 'page' => 'getPage', - 'page_size' => 'getPageSize', + 'page_size' => 'getPageSize' ]; /** @@ -239,6 +248,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -260,33 +270,34 @@ public function __construct(array $data = null) $this->setIfExists('page_size', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ListInfoResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ListInfoResponse { /** @var ListInfoResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ListInfoResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -303,7 +314,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -317,6 +330,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets num_pages * @@ -330,14 +344,14 @@ public function getNumPages() /** * Sets num_pages * - * @param int|null $num_pages total number of pages available + * @param int|null $num_pages Total number of pages available. * * @return self */ - public function setNumPages(?int $num_pages) + public function setNumPages($num_pages) { if (is_null($num_pages)) { - throw new InvalidArgumentException('non-nullable num_pages cannot be null'); + throw new \InvalidArgumentException('non-nullable num_pages cannot be null'); } $this->container['num_pages'] = $num_pages; @@ -357,18 +371,18 @@ public function getNumResults() /** * Sets num_results * - * @param int|null $num_results total number of objects available + * @param int|null $num_results Total number of objects available. * * @return self */ - public function setNumResults(?int $num_results) + public function setNumResults($num_results) { if (is_null($num_results)) { array_push($this->openAPINullablesSetToNull, 'num_results'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('num_results', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -391,14 +405,14 @@ public function getPage() /** * Sets page * - * @param int|null $page number of the page being returned + * @param int|null $page Number of the page being returned. * * @return self */ - public function setPage(?int $page) + public function setPage($page) { if (is_null($page)) { - throw new InvalidArgumentException('non-nullable page cannot be null'); + throw new \InvalidArgumentException('non-nullable page cannot be null'); } $this->container['page'] = $page; @@ -418,26 +432,27 @@ public function getPageSize() /** * Sets page_size * - * @param int|null $page_size objects returned per page + * @param int|null $page_size Objects returned per page. * * @return self */ - public function setPageSize(?int $page_size) + public function setPageSize($page_size) { if (is_null($page_size)) { - throw new InvalidArgumentException('non-nullable page_size cannot be null'); + throw new \InvalidArgumentException('non-nullable page_size cannot be null'); } $this->container['page_size'] = $page_size; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -446,11 +461,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -461,8 +476,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -475,9 +492,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -485,15 +504,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -519,3 +538,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ModelInterface.php b/sdks/php/src/Model/ModelInterface.php index 0bc2f212e..4127d706b 100644 --- a/sdks/php/src/Model/ModelInterface.php +++ b/sdks/php/src/Model/ModelInterface.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign\Model + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -29,6 +31,9 @@ /** * Interface abstracting model access. + * + * @package Dropbox\Sign\Model + * @author OpenAPI Generator team */ interface ModelInterface { @@ -91,11 +96,17 @@ public function valid(); /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool; /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool; } diff --git a/sdks/php/src/Model/OAuthTokenGenerateRequest.php b/sdks/php/src/Model/OAuthTokenGenerateRequest.php index 38a0395d1..0c51ddd3d 100644 --- a/sdks/php/src/Model/OAuthTokenGenerateRequest.php +++ b/sdks/php/src/Model/OAuthTokenGenerateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,76 +29,75 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * OAuthTokenGenerateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class OAuthTokenGenerateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class OAuthTokenGenerateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'OAuthTokenGenerateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'client_secret' => 'string', 'code' => 'string', 'grant_type' => 'string', - 'state' => 'string', + 'state' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'client_secret' => null, 'code' => null, 'grant_type' => null, - 'state' => null, + 'state' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'client_secret' => false, 'code' => false, 'grant_type' => false, - 'state' => false, + 'state' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -121,6 +122,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -130,7 +133,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +143,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,6 +152,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -157,6 +163,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -174,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'client_secret' => 'client_secret', 'code' => 'code', 'grant_type' => 'grant_type', - 'state' => 'state', + 'state' => 'state' ]; /** @@ -187,7 +196,7 @@ public function isNullableSetToNull(string $property): bool 'client_secret' => 'setClientSecret', 'code' => 'setCode', 'grant_type' => 'setGrantType', - 'state' => 'setState', + 'state' => 'setState' ]; /** @@ -200,7 +209,7 @@ public function isNullableSetToNull(string $property): bool 'client_secret' => 'getClientSecret', 'code' => 'getCode', 'grant_type' => 'getGrantType', - 'state' => 'getState', + 'state' => 'getState' ]; /** @@ -244,6 +253,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -266,33 +276,34 @@ public function __construct(array $data = null) $this->setIfExists('state', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): OAuthTokenGenerateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): OAuthTokenGenerateRequest { /** @var OAuthTokenGenerateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, OAuthTokenGenerateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -340,6 +351,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets client_id * @@ -353,14 +365,14 @@ public function getClientId() /** * Sets client_id * - * @param string $client_id the client id of the app requesting authorization + * @param string $client_id The client id of the app requesting authorization. * * @return self */ - public function setClientId(string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -380,14 +392,14 @@ public function getClientSecret() /** * Sets client_secret * - * @param string $client_secret the secret token of your app + * @param string $client_secret The secret token of your app. * * @return self */ - public function setClientSecret(string $client_secret) + public function setClientSecret($client_secret) { if (is_null($client_secret)) { - throw new InvalidArgumentException('non-nullable client_secret cannot be null'); + throw new \InvalidArgumentException('non-nullable client_secret cannot be null'); } $this->container['client_secret'] = $client_secret; @@ -407,14 +419,14 @@ public function getCode() /** * Sets code * - * @param string $code the code passed to your callback when the user granted access + * @param string $code The code passed to your callback when the user granted access. * * @return self */ - public function setCode(string $code) + public function setCode($code) { if (is_null($code)) { - throw new InvalidArgumentException('non-nullable code cannot be null'); + throw new \InvalidArgumentException('non-nullable code cannot be null'); } $this->container['code'] = $code; @@ -434,14 +446,14 @@ public function getGrantType() /** * Sets grant_type * - * @param string $grant_type when generating a new token use `authorization_code` + * @param string $grant_type When generating a new token use `authorization_code`. * * @return self */ - public function setGrantType(string $grant_type) + public function setGrantType($grant_type) { if (is_null($grant_type)) { - throw new InvalidArgumentException('non-nullable grant_type cannot be null'); + throw new \InvalidArgumentException('non-nullable grant_type cannot be null'); } $this->container['grant_type'] = $grant_type; @@ -461,26 +473,27 @@ public function getState() /** * Sets state * - * @param string $state same as the state you specified earlier + * @param string $state Same as the state you specified earlier. * * @return self */ - public function setState(string $state) + public function setState($state) { if (is_null($state)) { - throw new InvalidArgumentException('non-nullable state cannot be null'); + throw new \InvalidArgumentException('non-nullable state cannot be null'); } $this->container['state'] = $state; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -489,11 +502,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -504,8 +517,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -518,9 +533,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -528,15 +545,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -562,3 +579,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/OAuthTokenRefreshRequest.php b/sdks/php/src/Model/OAuthTokenRefreshRequest.php index 11cf05a3b..c92e1700e 100644 --- a/sdks/php/src/Model/OAuthTokenRefreshRequest.php +++ b/sdks/php/src/Model/OAuthTokenRefreshRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * OAuthTokenRefreshRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSerializable +class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'OAuthTokenRefreshRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'grant_type' => 'string', 'refresh_token' => 'string', 'client_id' => 'string', - 'client_secret' => 'string', + 'client_secret' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'grant_type' => null, 'refresh_token' => null, 'client_id' => null, - 'client_secret' => null, + 'client_secret' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'grant_type' => false, 'refresh_token' => false, 'client_id' => false, - 'client_secret' => false, + 'client_secret' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'grant_type' => 'grant_type', 'refresh_token' => 'refresh_token', 'client_id' => 'client_id', - 'client_secret' => 'client_secret', + 'client_secret' => 'client_secret' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'grant_type' => 'setGrantType', 'refresh_token' => 'setRefreshToken', 'client_id' => 'setClientId', - 'client_secret' => 'setClientSecret', + 'client_secret' => 'setClientSecret' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'grant_type' => 'getGrantType', 'refresh_token' => 'getRefreshToken', 'client_id' => 'getClientId', - 'client_secret' => 'getClientSecret', + 'client_secret' => 'getClientSecret' ]; /** @@ -238,6 +247,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -259,33 +269,34 @@ public function __construct(array $data = null) $this->setIfExists('client_secret', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): OAuthTokenRefreshRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): OAuthTokenRefreshRequest { /** @var OAuthTokenRefreshRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, OAuthTokenRefreshRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -324,6 +335,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets grant_type * @@ -337,14 +349,14 @@ public function getGrantType() /** * Sets grant_type * - * @param string $grant_type when refreshing an existing token use `refresh_token` + * @param string $grant_type When refreshing an existing token use `refresh_token`. * * @return self */ - public function setGrantType(string $grant_type) + public function setGrantType($grant_type) { if (is_null($grant_type)) { - throw new InvalidArgumentException('non-nullable grant_type cannot be null'); + throw new \InvalidArgumentException('non-nullable grant_type cannot be null'); } $this->container['grant_type'] = $grant_type; @@ -364,14 +376,14 @@ public function getRefreshToken() /** * Sets refresh_token * - * @param string $refresh_token the token provided when you got the expired access token + * @param string $refresh_token The token provided when you got the expired access token. * * @return self */ - public function setRefreshToken(string $refresh_token) + public function setRefreshToken($refresh_token) { if (is_null($refresh_token)) { - throw new InvalidArgumentException('non-nullable refresh_token cannot be null'); + throw new \InvalidArgumentException('non-nullable refresh_token cannot be null'); } $this->container['refresh_token'] = $refresh_token; @@ -395,10 +407,10 @@ public function getClientId() * * @return self */ - public function setClientId(?string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -422,22 +434,23 @@ public function getClientSecret() * * @return self */ - public function setClientSecret(?string $client_secret) + public function setClientSecret($client_secret) { if (is_null($client_secret)) { - throw new InvalidArgumentException('non-nullable client_secret cannot be null'); + throw new \InvalidArgumentException('non-nullable client_secret cannot be null'); } $this->container['client_secret'] = $client_secret; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -446,11 +459,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -461,8 +474,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -475,9 +490,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -485,15 +502,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -519,3 +536,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/OAuthTokenResponse.php b/sdks/php/src/Model/OAuthTokenResponse.php index 8c83de78e..8b936e6bd 100644 --- a/sdks/php/src/Model/OAuthTokenResponse.php +++ b/sdks/php/src/Model/OAuthTokenResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,76 +29,75 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * OAuthTokenResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class OAuthTokenResponse implements ModelInterface, ArrayAccess, JsonSerializable +class OAuthTokenResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'OAuthTokenResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'access_token' => 'string', 'token_type' => 'string', 'refresh_token' => 'string', 'expires_in' => 'int', - 'state' => 'string', + 'state' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'access_token' => null, 'token_type' => null, 'refresh_token' => null, 'expires_in' => null, - 'state' => null, + 'state' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'access_token' => false, 'token_type' => false, 'refresh_token' => false, 'expires_in' => false, - 'state' => true, + 'state' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -121,6 +122,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -130,7 +133,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +143,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,6 +152,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -157,6 +163,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -174,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'token_type' => 'token_type', 'refresh_token' => 'refresh_token', 'expires_in' => 'expires_in', - 'state' => 'state', + 'state' => 'state' ]; /** @@ -187,7 +196,7 @@ public function isNullableSetToNull(string $property): bool 'token_type' => 'setTokenType', 'refresh_token' => 'setRefreshToken', 'expires_in' => 'setExpiresIn', - 'state' => 'setState', + 'state' => 'setState' ]; /** @@ -200,7 +209,7 @@ public function isNullableSetToNull(string $property): bool 'token_type' => 'getTokenType', 'refresh_token' => 'getRefreshToken', 'expires_in' => 'getExpiresIn', - 'state' => 'getState', + 'state' => 'getState' ]; /** @@ -244,6 +253,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -266,33 +276,34 @@ public function __construct(array $data = null) $this->setIfExists('state', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): OAuthTokenResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): OAuthTokenResponse { /** @var OAuthTokenResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, OAuthTokenResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -309,7 +320,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -323,6 +336,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets access_token * @@ -340,10 +354,10 @@ public function getAccessToken() * * @return self */ - public function setAccessToken(?string $access_token) + public function setAccessToken($access_token) { if (is_null($access_token)) { - throw new InvalidArgumentException('non-nullable access_token cannot be null'); + throw new \InvalidArgumentException('non-nullable access_token cannot be null'); } $this->container['access_token'] = $access_token; @@ -367,10 +381,10 @@ public function getTokenType() * * @return self */ - public function setTokenType(?string $token_type) + public function setTokenType($token_type) { if (is_null($token_type)) { - throw new InvalidArgumentException('non-nullable token_type cannot be null'); + throw new \InvalidArgumentException('non-nullable token_type cannot be null'); } $this->container['token_type'] = $token_type; @@ -394,10 +408,10 @@ public function getRefreshToken() * * @return self */ - public function setRefreshToken(?string $refresh_token) + public function setRefreshToken($refresh_token) { if (is_null($refresh_token)) { - throw new InvalidArgumentException('non-nullable refresh_token cannot be null'); + throw new \InvalidArgumentException('non-nullable refresh_token cannot be null'); } $this->container['refresh_token'] = $refresh_token; @@ -421,10 +435,10 @@ public function getExpiresIn() * * @return self */ - public function setExpiresIn(?int $expires_in) + public function setExpiresIn($expires_in) { if (is_null($expires_in)) { - throw new InvalidArgumentException('non-nullable expires_in cannot be null'); + throw new \InvalidArgumentException('non-nullable expires_in cannot be null'); } $this->container['expires_in'] = $expires_in; @@ -448,14 +462,14 @@ public function getState() * * @return self */ - public function setState(?string $state) + public function setState($state) { if (is_null($state)) { array_push($this->openAPINullablesSetToNull, 'state'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('state', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -464,13 +478,14 @@ public function setState(?string $state) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -479,11 +494,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -494,8 +509,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -508,9 +525,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -518,15 +537,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -552,3 +571,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ReportCreateRequest.php b/sdks/php/src/Model/ReportCreateRequest.php index 58029634b..5315d3e9d 100644 --- a/sdks/php/src/Model/ReportCreateRequest.php +++ b/sdks/php/src/Model/ReportCreateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ReportCreateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ReportCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class ReportCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ReportCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'end_date' => 'string', 'report_type' => 'string[]', - 'start_date' => 'string', + 'start_date' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'end_date' => null, 'report_type' => null, - 'start_date' => null, + 'start_date' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'end_date' => false, 'report_type' => false, - 'start_date' => false, + 'start_date' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'end_date' => 'end_date', 'report_type' => 'report_type', - 'start_date' => 'start_date', + 'start_date' => 'start_date' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'end_date' => 'setEndDate', 'report_type' => 'setReportType', - 'start_date' => 'setStartDate', + 'start_date' => 'setStartDate' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'end_date' => 'getEndDate', 'report_type' => 'getReportType', - 'start_date' => 'getStartDate', + 'start_date' => 'getStartDate' ]; /** @@ -268,33 +277,34 @@ public function __construct(array $data = null) $this->setIfExists('start_date', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ReportCreateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ReportCreateRequest { /** @var ReportCreateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ReportCreateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -319,11 +329,11 @@ public function listInvalidProperties() if ($this->container['report_type'] === null) { $invalidProperties[] = "'report_type' can't be null"; } - if (count($this->container['report_type']) > 2) { + if ((count($this->container['report_type']) > 2)) { $invalidProperties[] = "invalid value for 'report_type', number of items must be less than or equal to 2."; } - if (count($this->container['report_type']) < 1) { + if ((count($this->container['report_type']) < 1)) { $invalidProperties[] = "invalid value for 'report_type', number of items must be greater than or equal to 1."; } @@ -344,6 +354,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets end_date * @@ -357,14 +368,14 @@ public function getEndDate() /** * Sets end_date * - * @param string $end_date the (inclusive) end date for the report data in `MM/DD/YYYY` format + * @param string $end_date The (inclusive) end date for the report data in `MM/DD/YYYY` format. * * @return self */ - public function setEndDate(string $end_date) + public function setEndDate($end_date) { if (is_null($end_date)) { - throw new InvalidArgumentException('non-nullable end_date cannot be null'); + throw new \InvalidArgumentException('non-nullable end_date cannot be null'); } $this->container['end_date'] = $end_date; @@ -388,14 +399,14 @@ public function getReportType() * * @return self */ - public function setReportType(array $report_type) + public function setReportType($report_type) { if (is_null($report_type)) { - throw new InvalidArgumentException('non-nullable report_type cannot be null'); + throw new \InvalidArgumentException('non-nullable report_type cannot be null'); } $allowedValues = $this->getReportTypeAllowableValues(); if (array_diff($report_type, $allowedValues)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value for 'report_type', must be one of '%s'", implode("', '", $allowedValues) @@ -403,11 +414,11 @@ public function setReportType(array $report_type) ); } - if (count($report_type) > 2) { - throw new InvalidArgumentException('invalid value for $report_type when calling ReportCreateRequest., number of items must be less than or equal to 2.'); + if ((count($report_type) > 2)) { + throw new \InvalidArgumentException('invalid value for $report_type when calling ReportCreateRequest., number of items must be less than or equal to 2.'); } - if (count($report_type) < 1) { - throw new InvalidArgumentException('invalid length for $report_type when calling ReportCreateRequest., number of items must be greater than or equal to 1.'); + if ((count($report_type) < 1)) { + throw new \InvalidArgumentException('invalid length for $report_type when calling ReportCreateRequest., number of items must be greater than or equal to 1.'); } $this->container['report_type'] = $report_type; @@ -427,26 +438,27 @@ public function getStartDate() /** * Sets start_date * - * @param string $start_date the (inclusive) start date for the report data in `MM/DD/YYYY` format + * @param string $start_date The (inclusive) start date for the report data in `MM/DD/YYYY` format. * * @return self */ - public function setStartDate(string $start_date) + public function setStartDate($start_date) { if (is_null($start_date)) { - throw new InvalidArgumentException('non-nullable start_date cannot be null'); + throw new \InvalidArgumentException('non-nullable start_date cannot be null'); } $this->container['start_date'] = $start_date; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -455,11 +467,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -470,8 +482,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -484,9 +498,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -494,15 +510,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -528,3 +544,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ReportCreateResponse.php b/sdks/php/src/Model/ReportCreateResponse.php index 415406e3c..33508edf2 100644 --- a/sdks/php/src/Model/ReportCreateResponse.php +++ b/sdks/php/src/Model/ReportCreateResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ReportCreateResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ReportCreateResponse implements ModelInterface, ArrayAccess, JsonSerializable +class ReportCreateResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ReportCreateResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'report' => '\Dropbox\Sign\Model\ReportResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'report' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'report' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'report' => 'report', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'report' => 'setReport', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'report' => 'getReport', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ReportCreateResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ReportCreateResponse { /** @var ReportCreateResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ReportCreateResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets report * - * @return ReportResponse + * @return \Dropbox\Sign\Model\ReportResponse */ public function getReport() { @@ -320,14 +332,14 @@ public function getReport() /** * Sets report * - * @param ReportResponse $report report + * @param \Dropbox\Sign\Model\ReportResponse $report report * * @return self */ - public function setReport(ReportResponse $report) + public function setReport($report) { if (is_null($report)) { - throw new InvalidArgumentException('non-nullable report cannot be null'); + throw new \InvalidArgumentException('non-nullable report cannot be null'); } $this->container['report'] = $report; @@ -337,7 +349,7 @@ public function setReport(ReportResponse $report) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/ReportResponse.php b/sdks/php/src/Model/ReportResponse.php index c2d024ca1..4b8c77cc7 100644 --- a/sdks/php/src/Model/ReportResponse.php +++ b/sdks/php/src/Model/ReportResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,74 +29,73 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * ReportResponse Class Doc Comment * * @category Class * @description Contains information about the report request. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class ReportResponse implements ModelInterface, ArrayAccess, JsonSerializable +class ReportResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ReportResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'success' => 'string', 'start_date' => 'string', 'end_date' => 'string', - 'report_type' => 'string[]', + 'report_type' => 'string[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'success' => null, 'start_date' => null, 'end_date' => null, - 'report_type' => null, + 'report_type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'success' => false, 'start_date' => false, 'end_date' => false, - 'report_type' => false, + 'report_type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,6 +120,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -128,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -138,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -147,6 +150,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -155,6 +161,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool 'success' => 'success', 'start_date' => 'start_date', 'end_date' => 'end_date', - 'report_type' => 'report_type', + 'report_type' => 'report_type' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'success' => 'setSuccess', 'start_date' => 'setStartDate', 'end_date' => 'setEndDate', - 'report_type' => 'setReportType', + 'report_type' => 'setReportType' ]; /** @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'success' => 'getSuccess', 'start_date' => 'getStartDate', 'end_date' => 'getEndDate', - 'report_type' => 'getReportType', + 'report_type' => 'getReportType' ]; /** @@ -276,33 +285,34 @@ public function __construct(array $data = null) $this->setIfExists('report_type', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): ReportResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): ReportResponse { /** @var ReportResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, ReportResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -319,7 +329,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -333,6 +345,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets success * @@ -350,10 +363,10 @@ public function getSuccess() * * @return self */ - public function setSuccess(?string $success) + public function setSuccess($success) { if (is_null($success)) { - throw new InvalidArgumentException('non-nullable success cannot be null'); + throw new \InvalidArgumentException('non-nullable success cannot be null'); } $this->container['success'] = $success; @@ -373,14 +386,14 @@ public function getStartDate() /** * Sets start_date * - * @param string|null $start_date the (inclusive) start date for the report data in MM/DD/YYYY format + * @param string|null $start_date The (inclusive) start date for the report data in MM/DD/YYYY format. * * @return self */ - public function setStartDate(?string $start_date) + public function setStartDate($start_date) { if (is_null($start_date)) { - throw new InvalidArgumentException('non-nullable start_date cannot be null'); + throw new \InvalidArgumentException('non-nullable start_date cannot be null'); } $this->container['start_date'] = $start_date; @@ -400,14 +413,14 @@ public function getEndDate() /** * Sets end_date * - * @param string|null $end_date the (inclusive) end date for the report data in MM/DD/YYYY format + * @param string|null $end_date The (inclusive) end date for the report data in MM/DD/YYYY format. * * @return self */ - public function setEndDate(?string $end_date) + public function setEndDate($end_date) { if (is_null($end_date)) { - throw new InvalidArgumentException('non-nullable end_date cannot be null'); + throw new \InvalidArgumentException('non-nullable end_date cannot be null'); } $this->container['end_date'] = $end_date; @@ -431,14 +444,14 @@ public function getReportType() * * @return self */ - public function setReportType(?array $report_type) + public function setReportType($report_type) { if (is_null($report_type)) { - throw new InvalidArgumentException('non-nullable report_type cannot be null'); + throw new \InvalidArgumentException('non-nullable report_type cannot be null'); } $allowedValues = $this->getReportTypeAllowableValues(); if (array_diff($report_type, $allowedValues)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value for 'report_type', must be one of '%s'", implode("', '", $allowedValues) @@ -449,13 +462,14 @@ public function setReportType(?array $report_type) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -464,11 +478,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -479,8 +493,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -493,9 +509,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -503,15 +521,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -537,3 +555,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php index 9c5947fec..ff41695c0 100644 --- a/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestBulkCreateEmbeddedWithTemplateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestBulkCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestBulkCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestBulkCreateEmbeddedWithTemplateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_ids' => 'string[]', 'client_id' => 'string', @@ -70,16 +70,16 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest implements ModelInte 'signing_redirect_url' => 'string', 'subject' => 'string', 'test_mode' => 'bool', - 'title' => 'string', + 'title' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_ids' => null, 'client_id' => null, @@ -93,14 +93,14 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest implements ModelInte 'signing_redirect_url' => null, 'subject' => null, 'test_mode' => null, - 'title' => null, + 'title' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'template_ids' => false, 'client_id' => false, @@ -114,14 +114,14 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest implements ModelInte 'signing_redirect_url' => false, 'subject' => false, 'test_mode' => false, - 'title' => false, + 'title' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -146,6 +146,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -155,7 +157,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -165,7 +167,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -174,6 +176,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -182,6 +187,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -207,7 +215,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'signing_redirect_url', 'subject' => 'subject', 'test_mode' => 'test_mode', - 'title' => 'title', + 'title' => 'title' ]; /** @@ -228,7 +236,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'setSigningRedirectUrl', 'subject' => 'setSubject', 'test_mode' => 'setTestMode', - 'title' => 'setTitle', + 'title' => 'setTitle' ]; /** @@ -249,7 +257,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'getSigningRedirectUrl', 'subject' => 'getSubject', 'test_mode' => 'getTestMode', - 'title' => 'getTitle', + 'title' => 'getTitle' ]; /** @@ -293,6 +301,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -323,33 +332,34 @@ public function __construct(array $data = null) $this->setIfExists('title', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestBulkCreateEmbeddedWithTemplateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestBulkCreateEmbeddedWithTemplateRequest { /** @var SignatureRequestBulkCreateEmbeddedWithTemplateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestBulkCreateEmbeddedWithTemplateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -400,6 +410,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template_ids * @@ -413,14 +424,14 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used + * @param string[] $template_ids Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. * * @return self */ - public function setTemplateIds(array $template_ids) + public function setTemplateIds($template_ids) { if (is_null($template_ids)) { - throw new InvalidArgumentException('non-nullable template_ids cannot be null'); + throw new \InvalidArgumentException('non-nullable template_ids cannot be null'); } $this->container['template_ids'] = $template_ids; @@ -444,10 +455,10 @@ public function getClientId() * * @return self */ - public function setClientId(string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -457,7 +468,7 @@ public function setClientId(string $client_id) /** * Gets signer_file * - * @return SplFileObject|null + * @return \SplFileObject|null */ public function getSignerFile() { @@ -467,14 +478,14 @@ public function getSignerFile() /** * Sets signer_file * - * @param SplFileObject|null $signer_file `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` + * @param \SplFileObject|null $signer_file `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` * * @return self */ - public function setSignerFile(?SplFileObject $signer_file) + public function setSignerFile($signer_file) { if (is_null($signer_file)) { - throw new InvalidArgumentException('non-nullable signer_file cannot be null'); + throw new \InvalidArgumentException('non-nullable signer_file cannot be null'); } $this->container['signer_file'] = $signer_file; @@ -484,7 +495,7 @@ public function setSignerFile(?SplFileObject $signer_file) /** * Gets signer_list * - * @return SubBulkSignerList[]|null + * @return \Dropbox\Sign\Model\SubBulkSignerList[]|null */ public function getSignerList() { @@ -494,14 +505,14 @@ public function getSignerList() /** * Sets signer_list * - * @param SubBulkSignerList[]|null $signer_list `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. + * @param \Dropbox\Sign\Model\SubBulkSignerList[]|null $signer_list `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. * * @return self */ - public function setSignerList(?array $signer_list) + public function setSignerList($signer_list) { if (is_null($signer_list)) { - throw new InvalidArgumentException('non-nullable signer_list cannot be null'); + throw new \InvalidArgumentException('non-nullable signer_list cannot be null'); } $this->container['signer_list'] = $signer_list; @@ -525,10 +536,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline(?bool $allow_decline) + public function setAllowDecline($allow_decline) { if (is_null($allow_decline)) { - throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -538,7 +549,7 @@ public function setAllowDecline(?bool $allow_decline) /** * Gets ccs * - * @return SubCC[]|null + * @return \Dropbox\Sign\Model\SubCC[]|null */ public function getCcs() { @@ -548,14 +559,14 @@ public function getCcs() /** * Sets ccs * - * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * @param \Dropbox\Sign\Model\SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. * * @return self */ - public function setCcs(?array $ccs) + public function setCcs($ccs) { if (is_null($ccs)) { - throw new InvalidArgumentException('non-nullable ccs cannot be null'); + throw new \InvalidArgumentException('non-nullable ccs cannot be null'); } $this->container['ccs'] = $ccs; @@ -565,7 +576,7 @@ public function setCcs(?array $ccs) /** * Gets custom_fields * - * @return SubCustomField[]|null + * @return \Dropbox\Sign\Model\SubCustomField[]|null */ public function getCustomFields() { @@ -575,14 +586,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -602,17 +613,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that will be sent to the signers + * @param string|null $message The custom message in the email that will be sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -637,12 +648,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -661,14 +673,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -688,17 +700,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that will be sent to the signers + * @param string|null $subject The subject in the email that will be sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 255) { - throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($subject) > 255)) { + throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -723,10 +735,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -746,30 +758,31 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title you want to assign to the SignatureRequest + * @param string|null $title The title you want to assign to the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } - if (mb_strlen($title) > 255) { - throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($title) > 255)) { + throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -778,11 +791,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -793,8 +806,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -807,9 +822,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -817,15 +834,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -851,3 +868,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php index 26092eb3f..47c8ed8ee 100644 --- a/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestBulkSendWithTemplateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestBulkSendWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestBulkSendWithTemplateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestBulkSendWithTemplateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_ids' => 'string[]', 'signer_file' => '\SplFileObject', @@ -70,16 +70,16 @@ class SignatureRequestBulkSendWithTemplateRequest implements ModelInterface, Arr 'signing_redirect_url' => 'string', 'subject' => 'string', 'test_mode' => 'bool', - 'title' => 'string', + 'title' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_ids' => null, 'signer_file' => 'binary', @@ -93,14 +93,14 @@ class SignatureRequestBulkSendWithTemplateRequest implements ModelInterface, Arr 'signing_redirect_url' => null, 'subject' => null, 'test_mode' => null, - 'title' => null, + 'title' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'template_ids' => false, 'signer_file' => false, @@ -114,14 +114,14 @@ class SignatureRequestBulkSendWithTemplateRequest implements ModelInterface, Arr 'signing_redirect_url' => false, 'subject' => false, 'test_mode' => false, - 'title' => false, + 'title' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -146,6 +146,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -155,7 +157,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -165,7 +167,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -174,6 +176,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -182,6 +187,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -207,7 +215,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'signing_redirect_url', 'subject' => 'subject', 'test_mode' => 'test_mode', - 'title' => 'title', + 'title' => 'title' ]; /** @@ -228,7 +236,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'setSigningRedirectUrl', 'subject' => 'setSubject', 'test_mode' => 'setTestMode', - 'title' => 'setTitle', + 'title' => 'setTitle' ]; /** @@ -249,7 +257,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'getSigningRedirectUrl', 'subject' => 'getSubject', 'test_mode' => 'getTestMode', - 'title' => 'getTitle', + 'title' => 'getTitle' ]; /** @@ -293,6 +301,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -323,33 +332,34 @@ public function __construct(array $data = null) $this->setIfExists('title', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestBulkSendWithTemplateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestBulkSendWithTemplateRequest { /** @var SignatureRequestBulkSendWithTemplateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestBulkSendWithTemplateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -397,6 +407,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template_ids * @@ -410,14 +421,14 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used + * @param string[] $template_ids Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. * * @return self */ - public function setTemplateIds(array $template_ids) + public function setTemplateIds($template_ids) { if (is_null($template_ids)) { - throw new InvalidArgumentException('non-nullable template_ids cannot be null'); + throw new \InvalidArgumentException('non-nullable template_ids cannot be null'); } $this->container['template_ids'] = $template_ids; @@ -427,7 +438,7 @@ public function setTemplateIds(array $template_ids) /** * Gets signer_file * - * @return SplFileObject|null + * @return \SplFileObject|null */ public function getSignerFile() { @@ -437,14 +448,14 @@ public function getSignerFile() /** * Sets signer_file * - * @param SplFileObject|null $signer_file `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` + * @param \SplFileObject|null $signer_file `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` * * @return self */ - public function setSignerFile(?SplFileObject $signer_file) + public function setSignerFile($signer_file) { if (is_null($signer_file)) { - throw new InvalidArgumentException('non-nullable signer_file cannot be null'); + throw new \InvalidArgumentException('non-nullable signer_file cannot be null'); } $this->container['signer_file'] = $signer_file; @@ -454,7 +465,7 @@ public function setSignerFile(?SplFileObject $signer_file) /** * Gets signer_list * - * @return SubBulkSignerList[]|null + * @return \Dropbox\Sign\Model\SubBulkSignerList[]|null */ public function getSignerList() { @@ -464,14 +475,14 @@ public function getSignerList() /** * Sets signer_list * - * @param SubBulkSignerList[]|null $signer_list `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. + * @param \Dropbox\Sign\Model\SubBulkSignerList[]|null $signer_list `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. * * @return self */ - public function setSignerList(?array $signer_list) + public function setSignerList($signer_list) { if (is_null($signer_list)) { - throw new InvalidArgumentException('non-nullable signer_list cannot be null'); + throw new \InvalidArgumentException('non-nullable signer_list cannot be null'); } $this->container['signer_list'] = $signer_list; @@ -495,10 +506,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline(?bool $allow_decline) + public function setAllowDecline($allow_decline) { if (is_null($allow_decline)) { - throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -508,7 +519,7 @@ public function setAllowDecline(?bool $allow_decline) /** * Gets ccs * - * @return SubCC[]|null + * @return \Dropbox\Sign\Model\SubCC[]|null */ public function getCcs() { @@ -518,14 +529,14 @@ public function getCcs() /** * Sets ccs * - * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * @param \Dropbox\Sign\Model\SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. * * @return self */ - public function setCcs(?array $ccs) + public function setCcs($ccs) { if (is_null($ccs)) { - throw new InvalidArgumentException('non-nullable ccs cannot be null'); + throw new \InvalidArgumentException('non-nullable ccs cannot be null'); } $this->container['ccs'] = $ccs; @@ -549,10 +560,10 @@ public function getClientId() * * @return self */ - public function setClientId(?string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -562,7 +573,7 @@ public function setClientId(?string $client_id) /** * Gets custom_fields * - * @return SubCustomField[]|null + * @return \Dropbox\Sign\Model\SubCustomField[]|null */ public function getCustomFields() { @@ -572,14 +583,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -599,17 +610,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that will be sent to the signers + * @param string|null $message The custom message in the email that will be sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -634,12 +645,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -658,14 +670,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -685,17 +697,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that will be sent to the signers + * @param string|null $subject The subject in the email that will be sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 255) { - throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($subject) > 255)) { + throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -720,10 +732,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -743,30 +755,31 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title you want to assign to the SignatureRequest + * @param string|null $title The title you want to assign to the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } - if (mb_strlen($title) > 255) { - throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($title) > 255)) { + throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -775,11 +788,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -790,8 +803,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -804,9 +819,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -814,15 +831,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -848,3 +865,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php index 7d14b823c..26262eb3e 100644 --- a/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php +++ b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestCreateEmbeddedRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestCreateEmbeddedRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'files' => '\SplFileObject[]', @@ -81,16 +81,16 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'title' => 'string', 'use_text_tags' => 'bool', 'populate_auto_fill_fields' => 'bool', - 'expires_at' => 'int', + 'expires_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'files' => 'binary', @@ -115,14 +115,14 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'title' => null, 'use_text_tags' => null, 'populate_auto_fill_fields' => null, - 'expires_at' => null, + 'expires_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'files' => false, @@ -147,14 +147,14 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'title' => false, 'use_text_tags' => false, 'populate_auto_fill_fields' => false, - 'expires_at' => true, + 'expires_at' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -179,6 +179,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -188,7 +190,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -198,7 +200,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -207,6 +209,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -215,6 +220,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -251,7 +259,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'title', 'use_text_tags' => 'use_text_tags', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', - 'expires_at' => 'expires_at', + 'expires_at' => 'expires_at' ]; /** @@ -283,7 +291,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', - 'expires_at' => 'setExpiresAt', + 'expires_at' => 'setExpiresAt' ]; /** @@ -315,7 +323,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', - 'expires_at' => 'getExpiresAt', + 'expires_at' => 'getExpiresAt' ]; /** @@ -359,6 +367,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -400,33 +409,34 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestCreateEmbeddedRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestCreateEmbeddedRequest { /** @var SignatureRequestCreateEmbeddedRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestCreateEmbeddedRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -474,6 +484,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets client_id * @@ -491,10 +502,10 @@ public function getClientId() * * @return self */ - public function setClientId(string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -504,7 +515,7 @@ public function setClientId(string $client_id) /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -514,14 +525,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -545,10 +556,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -558,7 +569,7 @@ public function setFileUrls(?array $file_urls) /** * Gets signers * - * @return SubSignatureRequestSigner[]|null + * @return \Dropbox\Sign\Model\SubSignatureRequestSigner[]|null */ public function getSigners() { @@ -568,14 +579,14 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param \Dropbox\Sign\Model\SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. * * @return self */ - public function setSigners(?array $signers) + public function setSigners($signers) { if (is_null($signers)) { - throw new InvalidArgumentException('non-nullable signers cannot be null'); + throw new \InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -585,7 +596,7 @@ public function setSigners(?array $signers) /** * Gets grouped_signers * - * @return SubSignatureRequestGroupedSigners[]|null + * @return \Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]|null */ public function getGroupedSigners() { @@ -595,14 +606,14 @@ public function getGroupedSigners() /** * Sets grouped_signers * - * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param \Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. * * @return self */ - public function setGroupedSigners(?array $grouped_signers) + public function setGroupedSigners($grouped_signers) { if (is_null($grouped_signers)) { - throw new InvalidArgumentException('non-nullable grouped_signers cannot be null'); + throw new \InvalidArgumentException('non-nullable grouped_signers cannot be null'); } $this->container['grouped_signers'] = $grouped_signers; @@ -626,10 +637,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline(?bool $allow_decline) + public function setAllowDecline($allow_decline) { if (is_null($allow_decline)) { - throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -653,10 +664,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign(?bool $allow_reassign) + public function setAllowReassign($allow_reassign) { if (is_null($allow_reassign)) { - throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -666,7 +677,7 @@ public function setAllowReassign(?bool $allow_reassign) /** * Gets attachments * - * @return SubAttachment[]|null + * @return \Dropbox\Sign\Model\SubAttachment[]|null */ public function getAttachments() { @@ -676,14 +687,14 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments(?array $attachments) + public function setAttachments($attachments) { if (is_null($attachments)) { - throw new InvalidArgumentException('non-nullable attachments cannot be null'); + throw new \InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -703,14 +714,14 @@ public function getCcEmailAddresses() /** * Sets cc_email_addresses * - * @param string[]|null $cc_email_addresses the email addresses that should be CCed + * @param string[]|null $cc_email_addresses The email addresses that should be CCed. * * @return self */ - public function setCcEmailAddresses(?array $cc_email_addresses) + public function setCcEmailAddresses($cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -720,7 +731,7 @@ public function setCcEmailAddresses(?array $cc_email_addresses) /** * Gets custom_fields * - * @return SubCustomField[]|null + * @return \Dropbox\Sign\Model\SubCustomField[]|null */ public function getCustomFields() { @@ -730,14 +741,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -747,7 +758,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets field_options * - * @return SubFieldOptions|null + * @return \Dropbox\Sign\Model\SubFieldOptions|null */ public function getFieldOptions() { @@ -757,14 +768,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param SubFieldOptions|null $field_options field_options + * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions(?SubFieldOptions $field_options) + public function setFieldOptions($field_options) { if (is_null($field_options)) { - throw new InvalidArgumentException('non-nullable field_options cannot be null'); + throw new \InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -774,7 +785,7 @@ public function setFieldOptions(?SubFieldOptions $field_options) /** * Gets form_field_groups * - * @return SubFormFieldGroup[]|null + * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -784,14 +795,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups(?array $form_field_groups) + public function setFormFieldGroups($form_field_groups) { if (is_null($form_field_groups)) { - throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -801,7 +812,7 @@ public function setFormFieldGroups(?array $form_field_groups) /** * Gets form_field_rules * - * @return SubFormFieldRule[]|null + * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -811,14 +822,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` + * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. * * @return self */ - public function setFormFieldRules(?array $form_field_rules) + public function setFormFieldRules($form_field_rules) { if (is_null($form_field_rules)) { - throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -828,7 +839,7 @@ public function setFormFieldRules(?array $form_field_rules) /** * Gets form_fields_per_document * - * @return SubFormFieldsPerDocumentBase[]|null + * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null */ public function getFormFieldsPerDocument() { @@ -838,14 +849,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument(?array $form_fields_per_document) + public function setFormFieldsPerDocument($form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -869,10 +880,10 @@ public function getHideTextTags() * * @return self */ - public function setHideTextTags(?bool $hide_text_tags) + public function setHideTextTags($hide_text_tags) { if (is_null($hide_text_tags)) { - throw new InvalidArgumentException('non-nullable hide_text_tags cannot be null'); + throw new \InvalidArgumentException('non-nullable hide_text_tags cannot be null'); } $this->container['hide_text_tags'] = $hide_text_tags; @@ -892,17 +903,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that will be sent to the signers + * @param string|null $message The custom message in the email that will be sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -927,12 +938,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -941,7 +953,7 @@ public function setMetadata(?array $metadata) /** * Gets signing_options * - * @return SubSigningOptions|null + * @return \Dropbox\Sign\Model\SubSigningOptions|null */ public function getSigningOptions() { @@ -951,14 +963,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param SubSigningOptions|null $signing_options signing_options + * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions(?SubSigningOptions $signing_options) + public function setSigningOptions($signing_options) { if (is_null($signing_options)) { - throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -978,17 +990,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that will be sent to the signers + * @param string|null $subject The subject in the email that will be sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 255) { - throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($subject) > 255)) { + throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -1013,10 +1025,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1036,17 +1048,17 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title you want to assign to the SignatureRequest + * @param string|null $title The title you want to assign to the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } - if (mb_strlen($title) > 255) { - throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($title) > 255)) { + throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; @@ -1071,10 +1083,10 @@ public function getUseTextTags() * * @return self */ - public function setUseTextTags(?bool $use_text_tags) + public function setUseTextTags($use_text_tags) { if (is_null($use_text_tags)) { - throw new InvalidArgumentException('non-nullable use_text_tags cannot be null'); + throw new \InvalidArgumentException('non-nullable use_text_tags cannot be null'); } $this->container['use_text_tags'] = $use_text_tags; @@ -1098,10 +1110,10 @@ public function getPopulateAutoFillFields() * * @return self */ - public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) + public function setPopulateAutoFillFields($populate_auto_fill_fields) { if (is_null($populate_auto_fill_fields)) { - throw new InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); } $this->container['populate_auto_fill_fields'] = $populate_auto_fill_fields; @@ -1125,14 +1137,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1141,13 +1153,14 @@ public function setExpiresAt(?int $expires_at) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1156,11 +1169,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1171,8 +1184,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1185,9 +1200,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1195,15 +1212,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1229,3 +1246,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php index b98f7b8b7..ac4b8551d 100644 --- a/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestCreateEmbeddedWithTemplateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestCreateEmbeddedWithTemplateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_ids' => 'string[]', 'client_id' => 'string', @@ -72,16 +72,16 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac 'subject' => 'string', 'test_mode' => 'bool', 'title' => 'string', - 'populate_auto_fill_fields' => 'bool', + 'populate_auto_fill_fields' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_ids' => null, 'client_id' => null, @@ -97,14 +97,14 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac 'subject' => null, 'test_mode' => null, 'title' => null, - 'populate_auto_fill_fields' => null, + 'populate_auto_fill_fields' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'template_ids' => false, 'client_id' => false, @@ -120,14 +120,14 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac 'subject' => false, 'test_mode' => false, 'title' => false, - 'populate_auto_fill_fields' => false, + 'populate_auto_fill_fields' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -152,6 +152,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -161,7 +163,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -171,7 +173,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -180,6 +182,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -188,6 +193,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -215,7 +223,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'subject', 'test_mode' => 'test_mode', 'title' => 'title', - 'populate_auto_fill_fields' => 'populate_auto_fill_fields', + 'populate_auto_fill_fields' => 'populate_auto_fill_fields' ]; /** @@ -238,7 +246,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'setSubject', 'test_mode' => 'setTestMode', 'title' => 'setTitle', - 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', + 'populate_auto_fill_fields' => 'setPopulateAutoFillFields' ]; /** @@ -261,7 +269,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'getSubject', 'test_mode' => 'getTestMode', 'title' => 'getTitle', - 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', + 'populate_auto_fill_fields' => 'getPopulateAutoFillFields' ]; /** @@ -305,6 +313,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -337,33 +346,34 @@ public function __construct(array $data = null) $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestCreateEmbeddedWithTemplateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestCreateEmbeddedWithTemplateRequest { /** @var SignatureRequestCreateEmbeddedWithTemplateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestCreateEmbeddedWithTemplateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -417,6 +427,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template_ids * @@ -430,14 +441,14 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used + * @param string[] $template_ids Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. * * @return self */ - public function setTemplateIds(array $template_ids) + public function setTemplateIds($template_ids) { if (is_null($template_ids)) { - throw new InvalidArgumentException('non-nullable template_ids cannot be null'); + throw new \InvalidArgumentException('non-nullable template_ids cannot be null'); } $this->container['template_ids'] = $template_ids; @@ -461,10 +472,10 @@ public function getClientId() * * @return self */ - public function setClientId(string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -474,7 +485,7 @@ public function setClientId(string $client_id) /** * Gets signers * - * @return SubSignatureRequestTemplateSigner[] + * @return \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[] */ public function getSigners() { @@ -484,14 +495,14 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestTemplateSigner[] $signers add Signers to your Templated-based Signature Request + * @param \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[] $signers Add Signers to your Templated-based Signature Request. * * @return self */ - public function setSigners(array $signers) + public function setSigners($signers) { if (is_null($signers)) { - throw new InvalidArgumentException('non-nullable signers cannot be null'); + throw new \InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -515,10 +526,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline(?bool $allow_decline) + public function setAllowDecline($allow_decline) { if (is_null($allow_decline)) { - throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -528,7 +539,7 @@ public function setAllowDecline(?bool $allow_decline) /** * Gets ccs * - * @return SubCC[]|null + * @return \Dropbox\Sign\Model\SubCC[]|null */ public function getCcs() { @@ -538,14 +549,14 @@ public function getCcs() /** * Sets ccs * - * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * @param \Dropbox\Sign\Model\SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. * * @return self */ - public function setCcs(?array $ccs) + public function setCcs($ccs) { if (is_null($ccs)) { - throw new InvalidArgumentException('non-nullable ccs cannot be null'); + throw new \InvalidArgumentException('non-nullable ccs cannot be null'); } $this->container['ccs'] = $ccs; @@ -555,7 +566,7 @@ public function setCcs(?array $ccs) /** * Gets custom_fields * - * @return SubCustomField[]|null + * @return \Dropbox\Sign\Model\SubCustomField[]|null */ public function getCustomFields() { @@ -565,14 +576,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. + * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -582,7 +593,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -592,14 +603,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -623,10 +634,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -646,17 +657,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that will be sent to the signers + * @param string|null $message The custom message in the email that will be sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -681,12 +692,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -695,7 +707,7 @@ public function setMetadata(?array $metadata) /** * Gets signing_options * - * @return SubSigningOptions|null + * @return \Dropbox\Sign\Model\SubSigningOptions|null */ public function getSigningOptions() { @@ -705,14 +717,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param SubSigningOptions|null $signing_options signing_options + * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions(?SubSigningOptions $signing_options) + public function setSigningOptions($signing_options) { if (is_null($signing_options)) { - throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -732,17 +744,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that will be sent to the signers + * @param string|null $subject The subject in the email that will be sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 255) { - throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($subject) > 255)) { + throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -767,10 +779,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -790,17 +802,17 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title you want to assign to the SignatureRequest + * @param string|null $title The title you want to assign to the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } - if (mb_strlen($title) > 255) { - throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($title) > 255)) { + throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; @@ -825,22 +837,23 @@ public function getPopulateAutoFillFields() * * @return self */ - public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) + public function setPopulateAutoFillFields($populate_auto_fill_fields) { if (is_null($populate_auto_fill_fields)) { - throw new InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); } $this->container['populate_auto_fill_fields'] = $populate_auto_fill_fields; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -849,11 +862,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -864,8 +877,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -878,9 +893,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -888,15 +905,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -922,3 +939,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestGetResponse.php b/sdks/php/src/Model/SignatureRequestGetResponse.php index 97f5f7c9f..8ea17ddd5 100644 --- a/sdks/php/src/Model/SignatureRequestGetResponse.php +++ b/sdks/php/src/Model/SignatureRequestGetResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestGetResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestGetResponse implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'signature_request' => '\Dropbox\Sign\Model\SignatureRequestResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'signature_request' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'signature_request' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'signature_request' => 'signature_request', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'signature_request' => 'setSignatureRequest', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'signature_request' => 'getSignatureRequest', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestGetResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestGetResponse { /** @var SignatureRequestGetResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestGetResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets signature_request * - * @return SignatureRequestResponse + * @return \Dropbox\Sign\Model\SignatureRequestResponse */ public function getSignatureRequest() { @@ -320,14 +332,14 @@ public function getSignatureRequest() /** * Sets signature_request * - * @param SignatureRequestResponse $signature_request signature_request + * @param \Dropbox\Sign\Model\SignatureRequestResponse $signature_request signature_request * * @return self */ - public function setSignatureRequest(SignatureRequestResponse $signature_request) + public function setSignatureRequest($signature_request) { if (is_null($signature_request)) { - throw new InvalidArgumentException('non-nullable signature_request cannot be null'); + throw new \InvalidArgumentException('non-nullable signature_request cannot be null'); } $this->container['signature_request'] = $signature_request; @@ -337,7 +349,7 @@ public function setSignatureRequest(SignatureRequestResponse $signature_request) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestListResponse.php b/sdks/php/src/Model/SignatureRequestListResponse.php index 659908071..45af0d46b 100644 --- a/sdks/php/src/Model/SignatureRequestListResponse.php +++ b/sdks/php/src/Model/SignatureRequestListResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestListResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestListResponse implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestListResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'signature_requests' => '\Dropbox\Sign\Model\SignatureRequestResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'signature_requests' => null, 'list_info' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'signature_requests' => false, 'list_info' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'signature_requests' => 'signature_requests', 'list_info' => 'list_info', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'signature_requests' => 'setSignatureRequests', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'signature_requests' => 'getSignatureRequests', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestListResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestListResponse { /** @var SignatureRequestListResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestListResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,10 +328,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets signature_requests * - * @return SignatureRequestResponse[] + * @return \Dropbox\Sign\Model\SignatureRequestResponse[] */ public function getSignatureRequests() { @@ -330,14 +342,14 @@ public function getSignatureRequests() /** * Sets signature_requests * - * @param SignatureRequestResponse[] $signature_requests contains information about signature requests + * @param \Dropbox\Sign\Model\SignatureRequestResponse[] $signature_requests Contains information about signature requests. * * @return self */ - public function setSignatureRequests(array $signature_requests) + public function setSignatureRequests($signature_requests) { if (is_null($signature_requests)) { - throw new InvalidArgumentException('non-nullable signature_requests cannot be null'); + throw new \InvalidArgumentException('non-nullable signature_requests cannot be null'); } $this->container['signature_requests'] = $signature_requests; @@ -347,7 +359,7 @@ public function setSignatureRequests(array $signature_requests) /** * Gets list_info * - * @return ListInfoResponse + * @return \Dropbox\Sign\Model\ListInfoResponse */ public function getListInfo() { @@ -357,14 +369,14 @@ public function getListInfo() /** * Sets list_info * - * @param ListInfoResponse $list_info list_info + * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo(ListInfoResponse $list_info) + public function setListInfo($list_info) { if (is_null($list_info)) { - throw new InvalidArgumentException('non-nullable list_info cannot be null'); + throw new \InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -374,7 +386,7 @@ public function setListInfo(ListInfoResponse $list_info) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -384,26 +396,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -412,11 +425,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -427,8 +440,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -441,9 +456,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -451,15 +468,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -485,3 +502,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestRemindRequest.php b/sdks/php/src/Model/SignatureRequestRemindRequest.php index 5662351ef..0e5e350ee 100644 --- a/sdks/php/src/Model/SignatureRequestRemindRequest.php +++ b/sdks/php/src/Model/SignatureRequestRemindRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestRemindRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestRemindRequest implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestRemindRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestRemindRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'email_address' => 'string', - 'name' => 'string', + 'name' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'email_address' => 'email', - 'name' => null, + 'name' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'email_address' => false, - 'name' => false, + 'name' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'email_address' => 'email_address', - 'name' => 'name', + 'name' => 'name' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'email_address' => 'setEmailAddress', - 'name' => 'setName', + 'name' => 'setName' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'email_address' => 'getEmailAddress', - 'name' => 'getName', + 'name' => 'getName' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestRemindRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestRemindRequest { /** @var SignatureRequestRemindRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestRemindRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,6 +318,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets email_address * @@ -320,14 +332,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address of the signer to send a reminder to + * @param string $email_address The email address of the signer to send a reminder to. * * @return self */ - public function setEmailAddress(string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -351,22 +363,23 @@ public function getName() * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponse.php b/sdks/php/src/Model/SignatureRequestResponse.php index 08442f436..254d3c2f9 100644 --- a/sdks/php/src/Model/SignatureRequestResponse.php +++ b/sdks/php/src/Model/SignatureRequestResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponse Class Doc Comment * * @category Class * @description Contains information about a signature request. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'test_mode' => 'bool', 'signature_request_id' => 'string', @@ -82,16 +83,16 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSeria 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', 'response_data' => '\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]', 'signatures' => '\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]', - 'bulk_send_job_id' => 'string', + 'bulk_send_job_id' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'test_mode' => null, 'signature_request_id' => null, @@ -117,14 +118,14 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSeria 'attachments' => null, 'response_data' => null, 'signatures' => null, - 'bulk_send_job_id' => null, + 'bulk_send_job_id' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'test_mode' => false, 'signature_request_id' => false, @@ -150,14 +151,14 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSeria 'attachments' => true, 'response_data' => true, 'signatures' => false, - 'bulk_send_job_id' => true, + 'bulk_send_job_id' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -182,6 +183,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -191,7 +194,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -201,7 +204,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -210,6 +213,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -218,6 +224,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -255,7 +264,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'attachments', 'response_data' => 'response_data', 'signatures' => 'signatures', - 'bulk_send_job_id' => 'bulk_send_job_id', + 'bulk_send_job_id' => 'bulk_send_job_id' ]; /** @@ -288,7 +297,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'setAttachments', 'response_data' => 'setResponseData', 'signatures' => 'setSignatures', - 'bulk_send_job_id' => 'setBulkSendJobId', + 'bulk_send_job_id' => 'setBulkSendJobId' ]; /** @@ -321,7 +330,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'getAttachments', 'response_data' => 'getResponseData', 'signatures' => 'getSignatures', - 'bulk_send_job_id' => 'getBulkSendJobId', + 'bulk_send_job_id' => 'getBulkSendJobId' ]; /** @@ -365,6 +374,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -407,33 +417,34 @@ public function __construct(array $data = null) $this->setIfExists('bulk_send_job_id', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponse { /** @var SignatureRequestResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -450,7 +461,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -464,6 +477,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets test_mode * @@ -481,10 +495,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -504,14 +518,14 @@ public function getSignatureRequestId() /** * Sets signature_request_id * - * @param string|null $signature_request_id the id of the SignatureRequest + * @param string|null $signature_request_id The id of the SignatureRequest. * * @return self */ - public function setSignatureRequestId(?string $signature_request_id) + public function setSignatureRequestId($signature_request_id) { if (is_null($signature_request_id)) { - throw new InvalidArgumentException('non-nullable signature_request_id cannot be null'); + throw new \InvalidArgumentException('non-nullable signature_request_id cannot be null'); } $this->container['signature_request_id'] = $signature_request_id; @@ -531,18 +545,18 @@ public function getRequesterEmailAddress() /** * Sets requester_email_address * - * @param string|null $requester_email_address the email address of the initiator of the SignatureRequest + * @param string|null $requester_email_address The email address of the initiator of the SignatureRequest. * * @return self */ - public function setRequesterEmailAddress(?string $requester_email_address) + public function setRequesterEmailAddress($requester_email_address) { if (is_null($requester_email_address)) { array_push($this->openAPINullablesSetToNull, 'requester_email_address'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('requester_email_address', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -565,14 +579,14 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title the specified Account uses for the SignatureRequest + * @param string|null $title The title the specified Account uses for the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -592,14 +606,14 @@ public function getOriginalTitle() /** * Sets original_title * - * @param string|null $original_title default Label for account + * @param string|null $original_title Default Label for account. * * @return self */ - public function setOriginalTitle(?string $original_title) + public function setOriginalTitle($original_title) { if (is_null($original_title)) { - throw new InvalidArgumentException('non-nullable original_title cannot be null'); + throw new \InvalidArgumentException('non-nullable original_title cannot be null'); } $this->container['original_title'] = $original_title; @@ -619,18 +633,18 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that was initially sent to the signers + * @param string|null $subject The subject in the email that was initially sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { array_push($this->openAPINullablesSetToNull, 'subject'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('subject', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -653,18 +667,18 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that was initially sent to the signers + * @param string|null $message The custom message in the email that was initially sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { array_push($this->openAPINullablesSetToNull, 'message'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('message', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -687,14 +701,14 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata the metadata attached to the signature request + * @param array|null $metadata The metadata attached to the signature request. * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } $this->container['metadata'] = $metadata; @@ -714,14 +728,14 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at time the signature request was created + * @param int|null $created_at Time the signature request was created. * * @return self */ - public function setCreatedAt(?int $created_at) + public function setCreatedAt($created_at) { if (is_null($created_at)) { - throw new InvalidArgumentException('non-nullable created_at cannot be null'); + throw new \InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; @@ -745,14 +759,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -775,14 +789,14 @@ public function getIsComplete() /** * Sets is_complete * - * @param bool|null $is_complete whether or not the SignatureRequest has been fully executed by all signers + * @param bool|null $is_complete Whether or not the SignatureRequest has been fully executed by all signers. * * @return self */ - public function setIsComplete(?bool $is_complete) + public function setIsComplete($is_complete) { if (is_null($is_complete)) { - throw new InvalidArgumentException('non-nullable is_complete cannot be null'); + throw new \InvalidArgumentException('non-nullable is_complete cannot be null'); } $this->container['is_complete'] = $is_complete; @@ -802,14 +816,14 @@ public function getIsDeclined() /** * Sets is_declined * - * @param bool|null $is_declined whether or not the SignatureRequest has been declined by a signer + * @param bool|null $is_declined Whether or not the SignatureRequest has been declined by a signer. * * @return self */ - public function setIsDeclined(?bool $is_declined) + public function setIsDeclined($is_declined) { if (is_null($is_declined)) { - throw new InvalidArgumentException('non-nullable is_declined cannot be null'); + throw new \InvalidArgumentException('non-nullable is_declined cannot be null'); } $this->container['is_declined'] = $is_declined; @@ -829,14 +843,14 @@ public function getHasError() /** * Sets has_error * - * @param bool|null $has_error whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings) + * @param bool|null $has_error Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). * * @return self */ - public function setHasError(?bool $has_error) + public function setHasError($has_error) { if (is_null($has_error)) { - throw new InvalidArgumentException('non-nullable has_error cannot be null'); + throw new \InvalidArgumentException('non-nullable has_error cannot be null'); } $this->container['has_error'] = $has_error; @@ -856,14 +870,14 @@ public function getFilesUrl() /** * Sets files_url * - * @param string|null $files_url the URL where a copy of the request's documents can be downloaded + * @param string|null $files_url The URL where a copy of the request's documents can be downloaded. * * @return self */ - public function setFilesUrl(?string $files_url) + public function setFilesUrl($files_url) { if (is_null($files_url)) { - throw new InvalidArgumentException('non-nullable files_url cannot be null'); + throw new \InvalidArgumentException('non-nullable files_url cannot be null'); } $this->container['files_url'] = $files_url; @@ -887,14 +901,14 @@ public function getSigningUrl() * * @return self */ - public function setSigningUrl(?string $signing_url) + public function setSigningUrl($signing_url) { if (is_null($signing_url)) { array_push($this->openAPINullablesSetToNull, 'signing_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signing_url', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -917,14 +931,14 @@ public function getDetailsUrl() /** * Sets details_url * - * @param string|null $details_url the URL where the requester and the signers can view the current status of the SignatureRequest + * @param string|null $details_url The URL where the requester and the signers can view the current status of the SignatureRequest. * * @return self */ - public function setDetailsUrl(?string $details_url) + public function setDetailsUrl($details_url) { if (is_null($details_url)) { - throw new InvalidArgumentException('non-nullable details_url cannot be null'); + throw new \InvalidArgumentException('non-nullable details_url cannot be null'); } $this->container['details_url'] = $details_url; @@ -948,10 +962,10 @@ public function getCcEmailAddresses() * * @return self */ - public function setCcEmailAddresses(?array $cc_email_addresses) + public function setCcEmailAddresses($cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -971,18 +985,18 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want the signer redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want the signer redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { array_push($this->openAPINullablesSetToNull, 'signing_redirect_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signing_redirect_url', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1009,14 +1023,14 @@ public function getFinalCopyUri() * * @return self */ - public function setFinalCopyUri(?string $final_copy_uri) + public function setFinalCopyUri($final_copy_uri) { if (is_null($final_copy_uri)) { array_push($this->openAPINullablesSetToNull, 'final_copy_uri'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('final_copy_uri', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1039,18 +1053,18 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[]|null $template_ids templates IDs used in this SignatureRequest (if any) + * @param string[]|null $template_ids Templates IDs used in this SignatureRequest (if any). * * @return self */ - public function setTemplateIds(?array $template_ids) + public function setTemplateIds($template_ids) { if (is_null($template_ids)) { array_push($this->openAPINullablesSetToNull, 'template_ids'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('template_ids', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1063,7 +1077,7 @@ public function setTemplateIds(?array $template_ids) /** * Gets custom_fields * - * @return SignatureRequestResponseCustomFieldBase[]|null + * @return \Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]|null */ public function getCustomFields() { @@ -1073,18 +1087,18 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SignatureRequestResponseCustomFieldBase[]|null $custom_fields An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * @param \Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]|null $custom_fields An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { array_push($this->openAPINullablesSetToNull, 'custom_fields'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('custom_fields', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1097,7 +1111,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets attachments * - * @return SignatureRequestResponseAttachment[]|null + * @return \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null */ public function getAttachments() { @@ -1107,18 +1121,18 @@ public function getAttachments() /** * Sets attachments * - * @param SignatureRequestResponseAttachment[]|null $attachments signer attachments + * @param \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null $attachments Signer attachments. * * @return self */ - public function setAttachments(?array $attachments) + public function setAttachments($attachments) { if (is_null($attachments)) { array_push($this->openAPINullablesSetToNull, 'attachments'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('attachments', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1131,7 +1145,7 @@ public function setAttachments(?array $attachments) /** * Gets response_data * - * @return SignatureRequestResponseDataBase[]|null + * @return \Dropbox\Sign\Model\SignatureRequestResponseDataBase[]|null */ public function getResponseData() { @@ -1141,18 +1155,18 @@ public function getResponseData() /** * Sets response_data * - * @param SignatureRequestResponseDataBase[]|null $response_data an array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers + * @param \Dropbox\Sign\Model\SignatureRequestResponseDataBase[]|null $response_data An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. * * @return self */ - public function setResponseData(?array $response_data) + public function setResponseData($response_data) { if (is_null($response_data)) { array_push($this->openAPINullablesSetToNull, 'response_data'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('response_data', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1165,7 +1179,7 @@ public function setResponseData(?array $response_data) /** * Gets signatures * - * @return SignatureRequestResponseSignatures[]|null + * @return \Dropbox\Sign\Model\SignatureRequestResponseSignatures[]|null */ public function getSignatures() { @@ -1175,14 +1189,14 @@ public function getSignatures() /** * Sets signatures * - * @param SignatureRequestResponseSignatures[]|null $signatures an array of signature objects, 1 for each signer + * @param \Dropbox\Sign\Model\SignatureRequestResponseSignatures[]|null $signatures An array of signature objects, 1 for each signer. * * @return self */ - public function setSignatures(?array $signatures) + public function setSignatures($signatures) { if (is_null($signatures)) { - throw new InvalidArgumentException('non-nullable signatures cannot be null'); + throw new \InvalidArgumentException('non-nullable signatures cannot be null'); } $this->container['signatures'] = $signatures; @@ -1202,18 +1216,18 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string|null $bulk_send_job_id the ID of the Bulk Send job which sent the signature request, if applicable + * @param string|null $bulk_send_job_id The ID of the Bulk Send job which sent the signature request, if applicable. * * @return self */ - public function setBulkSendJobId(?string $bulk_send_job_id) + public function setBulkSendJobId($bulk_send_job_id) { if (is_null($bulk_send_job_id)) { array_push($this->openAPINullablesSetToNull, 'bulk_send_job_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('bulk_send_job_id', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1222,13 +1236,14 @@ public function setBulkSendJobId(?string $bulk_send_job_id) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1237,11 +1252,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1252,8 +1267,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1266,9 +1283,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1276,15 +1295,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1310,3 +1329,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseAttachment.php b/sdks/php/src/Model/SignatureRequestResponseAttachment.php index 245930a52..7c38b92f0 100644 --- a/sdks/php/src/Model/SignatureRequestResponseAttachment.php +++ b/sdks/php/src/Model/SignatureRequestResponseAttachment.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,80 +29,79 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseAttachment Class Doc Comment * * @category Class * @description Signer attachments. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestResponseAttachment implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestResponseAttachment implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseAttachment'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'id' => 'string', 'signer' => 'string', 'name' => 'string', 'required' => 'bool', 'instructions' => 'string', - 'uploaded_at' => 'int', + 'uploaded_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'id' => null, 'signer' => null, 'name' => null, 'required' => null, 'instructions' => null, - 'uploaded_at' => null, + 'uploaded_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'id' => false, 'signer' => false, 'name' => false, 'required' => false, 'instructions' => true, - 'uploaded_at' => true, + 'uploaded_at' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -125,6 +126,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -134,7 +137,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -144,7 +147,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -153,6 +156,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -161,6 +167,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +188,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'required' => 'required', 'instructions' => 'instructions', - 'uploaded_at' => 'uploaded_at', + 'uploaded_at' => 'uploaded_at' ]; /** @@ -193,7 +202,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'required' => 'setRequired', 'instructions' => 'setInstructions', - 'uploaded_at' => 'setUploadedAt', + 'uploaded_at' => 'setUploadedAt' ]; /** @@ -207,7 +216,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'required' => 'getRequired', 'instructions' => 'getInstructions', - 'uploaded_at' => 'getUploadedAt', + 'uploaded_at' => 'getUploadedAt' ]; /** @@ -251,6 +260,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -274,33 +284,34 @@ public function __construct(array $data = null) $this->setIfExists('uploaded_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseAttachment { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseAttachment { /** @var SignatureRequestResponseAttachment */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseAttachment::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -345,6 +356,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets id * @@ -358,14 +370,14 @@ public function getId() /** * Sets id * - * @param string $id the unique ID for this attachment + * @param string $id The unique ID for this attachment. * * @return self */ - public function setId(string $id) + public function setId($id) { if (is_null($id)) { - throw new InvalidArgumentException('non-nullable id cannot be null'); + throw new \InvalidArgumentException('non-nullable id cannot be null'); } $this->container['id'] = $id; @@ -385,14 +397,14 @@ public function getSigner() /** * Sets signer * - * @param string $signer the Signer this attachment is assigned to + * @param string $signer The Signer this attachment is assigned to. * * @return self */ - public function setSigner(string $signer) + public function setSigner($signer) { if (is_null($signer)) { - throw new InvalidArgumentException('non-nullable signer cannot be null'); + throw new \InvalidArgumentException('non-nullable signer cannot be null'); } $this->container['signer'] = $signer; @@ -412,14 +424,14 @@ public function getName() /** * Sets name * - * @param string $name the name of this attachment + * @param string $name The name of this attachment. * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -439,14 +451,14 @@ public function getRequired() /** * Sets required * - * @param bool $required a boolean value denoting if this attachment is required + * @param bool $required A boolean value denoting if this attachment is required. * * @return self */ - public function setRequired(bool $required) + public function setRequired($required) { if (is_null($required)) { - throw new InvalidArgumentException('non-nullable required cannot be null'); + throw new \InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -466,18 +478,18 @@ public function getInstructions() /** * Sets instructions * - * @param string|null $instructions instructions for Signer + * @param string|null $instructions Instructions for Signer. * * @return self */ - public function setInstructions(?string $instructions) + public function setInstructions($instructions) { if (is_null($instructions)) { array_push($this->openAPINullablesSetToNull, 'instructions'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('instructions', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -500,18 +512,18 @@ public function getUploadedAt() /** * Sets uploaded_at * - * @param int|null $uploaded_at timestamp when attachment was uploaded by Signer + * @param int|null $uploaded_at Timestamp when attachment was uploaded by Signer. * * @return self */ - public function setUploadedAt(?int $uploaded_at) + public function setUploadedAt($uploaded_at) { if (is_null($uploaded_at)) { array_push($this->openAPINullablesSetToNull, 'uploaded_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('uploaded_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -520,13 +532,14 @@ public function setUploadedAt(?int $uploaded_at) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -535,11 +548,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -550,8 +563,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -564,9 +579,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -574,15 +591,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -608,3 +625,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php index bfa753e11..2d2fdeac0 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,77 +29,76 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseCustomFieldBase Class Doc Comment * * @category Class * @description An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestResponseCustomFieldBase implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestResponseCustomFieldBase implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseCustomFieldBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'name' => 'string', 'required' => 'bool', 'api_id' => 'string', - 'editor' => 'string', + 'editor' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'name' => null, 'required' => null, 'api_id' => null, - 'editor' => null, + 'editor' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'name' => false, 'required' => false, 'api_id' => false, - 'editor' => true, + 'editor' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -122,6 +123,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -131,7 +134,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +144,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,6 +153,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -158,6 +164,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'required' => 'required', 'api_id' => 'api_id', - 'editor' => 'editor', + 'editor' => 'editor' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'required' => 'setRequired', 'api_id' => 'setApiId', - 'editor' => 'setEditor', + 'editor' => 'setEditor' ]; /** @@ -201,7 +210,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'required' => 'getRequired', 'api_id' => 'getApiId', - 'editor' => 'getEditor', + 'editor' => 'getEditor' ]; /** @@ -245,6 +254,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -270,6 +280,7 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } + public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -287,12 +298,14 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -331,6 +344,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -348,10 +362,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -371,14 +385,14 @@ public function getName() /** * Sets name * - * @param string $name the name of the Custom Field + * @param string $name The name of the Custom Field. * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -398,14 +412,14 @@ public function getRequired() /** * Sets required * - * @param bool|null $required a boolean value denoting if this field is required + * @param bool|null $required A boolean value denoting if this field is required. * * @return self */ - public function setRequired(?bool $required) + public function setRequired($required) { if (is_null($required)) { - throw new InvalidArgumentException('non-nullable required cannot be null'); + throw new \InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -425,14 +439,14 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id the unique ID for this field + * @param string|null $api_id The unique ID for this field. * * @return self */ - public function setApiId(?string $api_id) + public function setApiId($api_id) { if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + throw new \InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -452,18 +466,18 @@ public function getEditor() /** * Sets editor * - * @param string|null $editor the name of the Role that is able to edit this field + * @param string|null $editor The name of the Role that is able to edit this field. * * @return self */ - public function setEditor(?string $editor) + public function setEditor($editor) { if (is_null($editor)) { array_push($this->openAPINullablesSetToNull, 'editor'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('editor', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -472,13 +486,14 @@ public function setEditor(?string $editor) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -487,11 +502,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -502,8 +517,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -516,9 +533,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -526,15 +545,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -560,3 +579,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php index d16c804e7..eef89e32f 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseCustomFieldCheckbox Class Doc Comment * * @category Class * @description This class extends `SignatureRequestResponseCustomFieldBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseCustomFieldCheckbox extends SignatureRequestResponseCustomFieldBase @@ -44,49 +45,49 @@ class SignatureRequestResponseCustomFieldCheckbox extends SignatureRequestRespon public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseCustomFieldCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'bool', + 'value' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,6 +112,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -120,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,6 +142,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -147,6 +153,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -161,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -181,7 +190,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -225,6 +234,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -239,33 +250,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseCustomFieldCheckbox { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseCustomFieldCheckbox { /** @var SignatureRequestResponseCustomFieldCheckbox */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseCustomFieldCheckbox::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -301,6 +313,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -318,10 +331,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -345,22 +358,23 @@ public function getValue() * * @return self */ - public function setValue(?bool $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -369,11 +383,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -384,8 +398,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -398,9 +414,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -408,15 +426,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -442,3 +460,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php index 4115fc171..62a23a317 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseCustomFieldText Class Doc Comment * * @category Class * @description This class extends `SignatureRequestResponseCustomFieldBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseCustomFieldText extends SignatureRequestResponseCustomFieldBase @@ -44,49 +45,49 @@ class SignatureRequestResponseCustomFieldText extends SignatureRequestResponseCu public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseCustomFieldText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string', + 'value' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,6 +112,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -120,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,6 +142,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -147,6 +153,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -161,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -181,7 +190,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -225,6 +234,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -239,33 +250,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseCustomFieldText { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseCustomFieldText { /** @var SignatureRequestResponseCustomFieldText */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseCustomFieldText::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -301,6 +313,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -318,10 +331,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -345,22 +358,23 @@ public function getValue() * * @return self */ - public function setValue(?string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -369,11 +383,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -384,8 +398,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -398,9 +414,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -408,15 +426,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -442,3 +460,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldTypeEnum.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldTypeEnum.php index c9f4ea0a2..d00c3cffb 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldTypeEnum.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldTypeEnum.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,12 +28,15 @@ */ namespace Dropbox\Sign\Model; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseCustomFieldTypeEnum Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class SignatureRequestResponseCustomFieldTypeEnum { @@ -50,7 +55,9 @@ public static function getAllowableEnumValues() { return [ self::TEXT, - self::CHECKBOX, + self::CHECKBOX ]; } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataBase.php b/sdks/php/src/Model/SignatureRequestResponseDataBase.php index 5f473fe7f..0beb2d845 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataBase.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataBase.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,77 +29,76 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataBase Class Doc Comment * * @category Class * @description An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestResponseDataBase implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestResponseDataBase implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'api_id' => 'string', 'signature_id' => 'string', 'name' => 'string', 'required' => 'bool', - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'api_id' => null, 'signature_id' => null, 'name' => null, 'required' => null, - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'api_id' => false, 'signature_id' => false, 'name' => false, 'required' => false, - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -122,6 +123,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -131,7 +134,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +144,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,6 +153,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -158,6 +164,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'signature_id', 'name' => 'name', 'required' => 'required', - 'type' => 'type', + 'type' => 'type' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'setSignatureId', 'name' => 'setName', 'required' => 'setRequired', - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -201,7 +210,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'getSignatureId', 'name' => 'getName', 'required' => 'getRequired', - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -245,6 +254,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -270,6 +280,7 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } + public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -308,12 +319,14 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -330,7 +343,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -344,6 +359,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets api_id * @@ -357,14 +373,14 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id the unique ID for this field + * @param string|null $api_id The unique ID for this field. * * @return self */ - public function setApiId(?string $api_id) + public function setApiId($api_id) { if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + throw new \InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -384,14 +400,14 @@ public function getSignatureId() /** * Sets signature_id * - * @param string|null $signature_id the ID of the signature to which this response is linked + * @param string|null $signature_id The ID of the signature to which this response is linked. * * @return self */ - public function setSignatureId(?string $signature_id) + public function setSignatureId($signature_id) { if (is_null($signature_id)) { - throw new InvalidArgumentException('non-nullable signature_id cannot be null'); + throw new \InvalidArgumentException('non-nullable signature_id cannot be null'); } $this->container['signature_id'] = $signature_id; @@ -411,14 +427,14 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the form field + * @param string|null $name The name of the form field. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -438,14 +454,14 @@ public function getRequired() /** * Sets required * - * @param bool|null $required a boolean value denoting if this field is required + * @param bool|null $required A boolean value denoting if this field is required. * * @return self */ - public function setRequired(?bool $required) + public function setRequired($required) { if (is_null($required)) { - throw new InvalidArgumentException('non-nullable required cannot be null'); + throw new \InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -469,22 +485,23 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -493,11 +510,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -508,8 +525,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -522,9 +541,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -532,15 +553,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -566,3 +587,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataTypeEnum.php b/sdks/php/src/Model/SignatureRequestResponseDataTypeEnum.php index fd4b6e268..59a807635 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataTypeEnum.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataTypeEnum.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,12 +28,15 @@ */ namespace Dropbox\Sign\Model; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataTypeEnum Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class SignatureRequestResponseDataTypeEnum { @@ -71,7 +76,9 @@ public static function getAllowableEnumValues() self::RADIO, self::SIGNATURE, self::TEXT_MERGE, - self::CHECKBOX_MERGE, + self::CHECKBOX_MERGE ]; } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php index c64a1fbc7..7413b5813 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,16 +28,15 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataValueCheckbox Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueCheckbox extends SignatureRequestResponseDataBase @@ -43,49 +44,49 @@ class SignatureRequestResponseDataValueCheckbox extends SignatureRequestResponse public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'bool', + 'value' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -160,7 +169,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -180,7 +189,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -224,6 +233,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -238,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseDataValueCheckbox { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseDataValueCheckbox { /** @var SignatureRequestResponseDataValueCheckbox */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueCheckbox::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return parent::listInvalidProperties(); + $invalidProperties = parent::listInvalidProperties(); + + return $invalidProperties; } /** @@ -295,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -312,10 +327,10 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -335,26 +350,27 @@ public function getValue() /** * Sets value * - * @param bool|null $value the value of the form field + * @param bool|null $value The value of the form field. * * @return self */ - public function setValue(?bool $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -363,11 +379,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -378,8 +394,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -392,9 +410,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -402,15 +422,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -436,3 +456,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php index 96ac1dd3e..d0d99e61b 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,16 +28,15 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataValueCheckboxMerge Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueCheckboxMerge extends SignatureRequestResponseDataBase @@ -43,49 +44,49 @@ class SignatureRequestResponseDataValueCheckboxMerge extends SignatureRequestRes public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueCheckboxMerge'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string', + 'value' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -160,7 +169,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -180,7 +189,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -224,6 +233,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -238,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseDataValueCheckboxMerge { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseDataValueCheckboxMerge { /** @var SignatureRequestResponseDataValueCheckboxMerge */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueCheckboxMerge::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return parent::listInvalidProperties(); + $invalidProperties = parent::listInvalidProperties(); + + return $invalidProperties; } /** @@ -295,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -312,10 +327,10 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -335,26 +350,27 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value The value of the form field. * * @return self */ - public function setValue(?string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -363,11 +379,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -378,8 +394,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -392,9 +410,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -402,15 +422,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -436,3 +456,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php b/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php index 78c8794e0..2a9185da1 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,16 +28,15 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataValueDateSigned Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueDateSigned extends SignatureRequestResponseDataBase @@ -43,49 +44,49 @@ class SignatureRequestResponseDataValueDateSigned extends SignatureRequestRespon public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueDateSigned'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string', + 'value' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -160,7 +169,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -180,7 +189,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -224,6 +233,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -238,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseDataValueDateSigned { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseDataValueDateSigned { /** @var SignatureRequestResponseDataValueDateSigned */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueDateSigned::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return parent::listInvalidProperties(); + $invalidProperties = parent::listInvalidProperties(); + + return $invalidProperties; } /** @@ -295,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -312,10 +327,10 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -335,26 +350,27 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value The value of the form field. * * @return self */ - public function setValue(?string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -363,11 +379,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -378,8 +394,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -392,9 +410,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -402,15 +422,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -436,3 +456,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php b/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php index 4171a5860..75b6996dc 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,16 +28,15 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataValueDropdown Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueDropdown extends SignatureRequestResponseDataBase @@ -43,49 +44,49 @@ class SignatureRequestResponseDataValueDropdown extends SignatureRequestResponse public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueDropdown'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string', + 'value' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -160,7 +169,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -180,7 +189,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -224,6 +233,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -238,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseDataValueDropdown { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseDataValueDropdown { /** @var SignatureRequestResponseDataValueDropdown */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueDropdown::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return parent::listInvalidProperties(); + $invalidProperties = parent::listInvalidProperties(); + + return $invalidProperties; } /** @@ -295,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -312,10 +327,10 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -335,26 +350,27 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value The value of the form field. * * @return self */ - public function setValue(?string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -363,11 +379,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -378,8 +394,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -392,9 +410,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -402,15 +422,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -436,3 +456,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php b/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php index 25ed14574..7ced50121 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,16 +28,15 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataValueInitials Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueInitials extends SignatureRequestResponseDataBase @@ -43,52 +44,52 @@ class SignatureRequestResponseDataValueInitials extends SignatureRequestResponse public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueInitials'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'value' => 'string', - 'is_signed' => 'bool', + 'is_signed' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'value' => null, - 'is_signed' => null, + 'is_signed' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'value' => false, - 'is_signed' => true, + 'is_signed' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -164,7 +173,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'value' => 'value', - 'is_signed' => 'is_signed', + 'is_signed' => 'is_signed' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'value' => 'setValue', - 'is_signed' => 'setIsSigned', + 'is_signed' => 'setIsSigned' ]; /** @@ -186,7 +195,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'value' => 'getValue', - 'is_signed' => 'getIsSigned', + 'is_signed' => 'getIsSigned' ]; /** @@ -230,6 +239,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -245,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('is_signed', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseDataValueInitials { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseDataValueInitials { /** @var SignatureRequestResponseDataValueInitials */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueInitials::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -288,7 +300,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return parent::listInvalidProperties(); + $invalidProperties = parent::listInvalidProperties(); + + return $invalidProperties; } /** @@ -302,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -319,10 +334,10 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -342,14 +357,14 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value The value of the form field. * * @return self */ - public function setValue(?string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; @@ -369,18 +384,18 @@ public function getIsSigned() /** * Sets is_signed * - * @param bool|null $is_signed this field contains the boolean true if the field is signed + * @param bool|null $is_signed This field contains the boolean true if the field is signed. * * @return self */ - public function setIsSigned(?bool $is_signed) + public function setIsSigned($is_signed) { if (is_null($is_signed)) { array_push($this->openAPINullablesSetToNull, 'is_signed'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('is_signed', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -389,13 +404,14 @@ public function setIsSigned(?bool $is_signed) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -404,11 +420,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -419,8 +435,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -433,9 +451,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -443,15 +463,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -477,3 +497,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php b/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php index 0c05b0bc9..6259408f1 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,16 +28,15 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataValueRadio Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueRadio extends SignatureRequestResponseDataBase @@ -43,49 +44,49 @@ class SignatureRequestResponseDataValueRadio extends SignatureRequestResponseDat public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueRadio'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'bool', + 'value' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -160,7 +169,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -180,7 +189,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -224,6 +233,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -238,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseDataValueRadio { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseDataValueRadio { /** @var SignatureRequestResponseDataValueRadio */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueRadio::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return parent::listInvalidProperties(); + $invalidProperties = parent::listInvalidProperties(); + + return $invalidProperties; } /** @@ -295,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -312,10 +327,10 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -335,26 +350,27 @@ public function getValue() /** * Sets value * - * @param bool|null $value the value of the form field + * @param bool|null $value The value of the form field. * * @return self */ - public function setValue(?bool $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -363,11 +379,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -378,8 +394,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -392,9 +410,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -402,15 +422,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -436,3 +456,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php b/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php index b72a8c1fc..3333c5f6c 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,16 +28,15 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataValueSignature Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueSignature extends SignatureRequestResponseDataBase @@ -43,52 +44,52 @@ class SignatureRequestResponseDataValueSignature extends SignatureRequestRespons public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueSignature'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'value' => 'string', - 'is_signed' => 'bool', + 'is_signed' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'value' => null, - 'is_signed' => null, + 'is_signed' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'value' => false, - 'is_signed' => true, + 'is_signed' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -164,7 +173,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'value' => 'value', - 'is_signed' => 'is_signed', + 'is_signed' => 'is_signed' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'value' => 'setValue', - 'is_signed' => 'setIsSigned', + 'is_signed' => 'setIsSigned' ]; /** @@ -186,7 +195,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'value' => 'getValue', - 'is_signed' => 'getIsSigned', + 'is_signed' => 'getIsSigned' ]; /** @@ -230,6 +239,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -245,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('is_signed', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseDataValueSignature { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseDataValueSignature { /** @var SignatureRequestResponseDataValueSignature */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueSignature::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -288,7 +300,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return parent::listInvalidProperties(); + $invalidProperties = parent::listInvalidProperties(); + + return $invalidProperties; } /** @@ -302,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -319,10 +334,10 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -342,14 +357,14 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value The value of the form field. * * @return self */ - public function setValue(?string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; @@ -369,18 +384,18 @@ public function getIsSigned() /** * Sets is_signed * - * @param bool|null $is_signed this field contains the boolean true if the field is signed + * @param bool|null $is_signed This field contains the boolean true if the field is signed. * * @return self */ - public function setIsSigned(?bool $is_signed) + public function setIsSigned($is_signed) { if (is_null($is_signed)) { array_push($this->openAPINullablesSetToNull, 'is_signed'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('is_signed', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -389,13 +404,14 @@ public function setIsSigned(?bool $is_signed) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -404,11 +420,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -419,8 +435,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -433,9 +451,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -443,15 +463,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -477,3 +497,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueText.php b/sdks/php/src/Model/SignatureRequestResponseDataValueText.php index f4ddd0ff3..668060f61 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueText.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueText.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,16 +28,15 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataValueText Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueText extends SignatureRequestResponseDataBase @@ -43,49 +44,49 @@ class SignatureRequestResponseDataValueText extends SignatureRequestResponseData public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string', + 'value' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -160,7 +169,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -180,7 +189,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -224,6 +233,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -238,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseDataValueText { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseDataValueText { /** @var SignatureRequestResponseDataValueText */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueText::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return parent::listInvalidProperties(); + $invalidProperties = parent::listInvalidProperties(); + + return $invalidProperties; } /** @@ -295,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -312,10 +327,10 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -335,26 +350,27 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value The value of the form field. * * @return self */ - public function setValue(?string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -363,11 +379,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -378,8 +394,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -392,9 +410,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -402,15 +422,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -436,3 +456,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php b/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php index ef64d4b8e..d159e98fe 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,16 +28,15 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataValueTextMerge Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueTextMerge extends SignatureRequestResponseDataBase @@ -43,49 +44,49 @@ class SignatureRequestResponseDataValueTextMerge extends SignatureRequestRespons public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueTextMerge'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string', + 'value' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -160,7 +169,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -180,7 +189,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -224,6 +233,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -238,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseDataValueTextMerge { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseDataValueTextMerge { /** @var SignatureRequestResponseDataValueTextMerge */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueTextMerge::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return parent::listInvalidProperties(); + $invalidProperties = parent::listInvalidProperties(); + + return $invalidProperties; } /** @@ -295,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -312,10 +327,10 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -335,26 +350,27 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value The value of the form field. * * @return self */ - public function setValue(?string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -363,11 +379,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -378,8 +394,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -392,9 +410,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -402,15 +422,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -436,3 +456,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestResponseSignatures.php b/sdks/php/src/Model/SignatureRequestResponseSignatures.php index 081ebb6d3..62376d373 100644 --- a/sdks/php/src/Model/SignatureRequestResponseSignatures.php +++ b/sdks/php/src/Model/SignatureRequestResponseSignatures.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseSignatures Class Doc Comment * * @category Class * @description An array of signature objects, 1 for each signer. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestResponseSignatures implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestResponseSignatures implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseSignatures'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'signature_id' => 'string', 'signer_group_guid' => 'string', @@ -76,16 +77,16 @@ class SignatureRequestResponseSignatures implements ModelInterface, ArrayAccess, 'reassigned_by' => 'string', 'reassignment_reason' => 'string', 'reassigned_from' => 'string', - 'error' => 'string', + 'error' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'signature_id' => null, 'signer_group_guid' => null, @@ -105,14 +106,14 @@ class SignatureRequestResponseSignatures implements ModelInterface, ArrayAccess, 'reassigned_by' => null, 'reassignment_reason' => null, 'reassigned_from' => null, - 'error' => null, + 'error' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'signature_id' => false, 'signer_group_guid' => true, @@ -132,14 +133,14 @@ class SignatureRequestResponseSignatures implements ModelInterface, ArrayAccess, 'reassigned_by' => true, 'reassignment_reason' => true, 'reassigned_from' => true, - 'error' => true, + 'error' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -164,6 +165,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -173,7 +176,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -183,7 +186,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -192,6 +195,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -200,6 +206,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -231,7 +240,7 @@ public function isNullableSetToNull(string $property): bool 'reassigned_by' => 'reassigned_by', 'reassignment_reason' => 'reassignment_reason', 'reassigned_from' => 'reassigned_from', - 'error' => 'error', + 'error' => 'error' ]; /** @@ -258,7 +267,7 @@ public function isNullableSetToNull(string $property): bool 'reassigned_by' => 'setReassignedBy', 'reassignment_reason' => 'setReassignmentReason', 'reassigned_from' => 'setReassignedFrom', - 'error' => 'setError', + 'error' => 'setError' ]; /** @@ -285,7 +294,7 @@ public function isNullableSetToNull(string $property): bool 'reassigned_by' => 'getReassignedBy', 'reassignment_reason' => 'getReassignmentReason', 'reassigned_from' => 'getReassignedFrom', - 'error' => 'getError', + 'error' => 'getError' ]; /** @@ -329,6 +338,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -365,33 +375,34 @@ public function __construct(array $data = null) $this->setIfExists('error', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestResponseSignatures { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestResponseSignatures { /** @var SignatureRequestResponseSignatures */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestResponseSignatures::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -408,7 +419,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -422,6 +435,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets signature_id * @@ -435,14 +449,14 @@ public function getSignatureId() /** * Sets signature_id * - * @param string|null $signature_id signature identifier + * @param string|null $signature_id Signature identifier. * * @return self */ - public function setSignatureId(?string $signature_id) + public function setSignatureId($signature_id) { if (is_null($signature_id)) { - throw new InvalidArgumentException('non-nullable signature_id cannot be null'); + throw new \InvalidArgumentException('non-nullable signature_id cannot be null'); } $this->container['signature_id'] = $signature_id; @@ -466,14 +480,14 @@ public function getSignerGroupGuid() * * @return self */ - public function setSignerGroupGuid(?string $signer_group_guid) + public function setSignerGroupGuid($signer_group_guid) { if (is_null($signer_group_guid)) { array_push($this->openAPINullablesSetToNull, 'signer_group_guid'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signer_group_guid', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -496,14 +510,14 @@ public function getSignerEmailAddress() /** * Sets signer_email_address * - * @param string|null $signer_email_address the email address of the signer + * @param string|null $signer_email_address The email address of the signer. * * @return self */ - public function setSignerEmailAddress(?string $signer_email_address) + public function setSignerEmailAddress($signer_email_address) { if (is_null($signer_email_address)) { - throw new InvalidArgumentException('non-nullable signer_email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable signer_email_address cannot be null'); } $this->container['signer_email_address'] = $signer_email_address; @@ -523,18 +537,18 @@ public function getSignerName() /** * Sets signer_name * - * @param string|null $signer_name the name of the signer + * @param string|null $signer_name The name of the signer. * * @return self */ - public function setSignerName(?string $signer_name) + public function setSignerName($signer_name) { if (is_null($signer_name)) { array_push($this->openAPINullablesSetToNull, 'signer_name'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signer_name', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -557,18 +571,18 @@ public function getSignerRole() /** * Sets signer_role * - * @param string|null $signer_role the role of the signer + * @param string|null $signer_role The role of the signer. * * @return self */ - public function setSignerRole(?string $signer_role) + public function setSignerRole($signer_role) { if (is_null($signer_role)) { array_push($this->openAPINullablesSetToNull, 'signer_role'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signer_role', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -591,18 +605,18 @@ public function getOrder() /** * Sets order * - * @param int|null $order if signer order is assigned this is the 0-based index for this signer + * @param int|null $order If signer order is assigned this is the 0-based index for this signer. * * @return self */ - public function setOrder(?int $order) + public function setOrder($order) { if (is_null($order)) { array_push($this->openAPINullablesSetToNull, 'order'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('order', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -629,10 +643,10 @@ public function getStatusCode() * * @return self */ - public function setStatusCode(?string $status_code) + public function setStatusCode($status_code) { if (is_null($status_code)) { - throw new InvalidArgumentException('non-nullable status_code cannot be null'); + throw new \InvalidArgumentException('non-nullable status_code cannot be null'); } $this->container['status_code'] = $status_code; @@ -652,18 +666,18 @@ public function getDeclineReason() /** * Sets decline_reason * - * @param string|null $decline_reason the reason provided by the signer for declining the request + * @param string|null $decline_reason The reason provided by the signer for declining the request. * * @return self */ - public function setDeclineReason(?string $decline_reason) + public function setDeclineReason($decline_reason) { if (is_null($decline_reason)) { array_push($this->openAPINullablesSetToNull, 'decline_reason'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('decline_reason', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -686,18 +700,18 @@ public function getSignedAt() /** * Sets signed_at * - * @param int|null $signed_at time that the document was signed or null + * @param int|null $signed_at Time that the document was signed or null. * * @return self */ - public function setSignedAt(?int $signed_at) + public function setSignedAt($signed_at) { if (is_null($signed_at)) { array_push($this->openAPINullablesSetToNull, 'signed_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signed_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -720,18 +734,18 @@ public function getLastViewedAt() /** * Sets last_viewed_at * - * @param int|null $last_viewed_at the time that the document was last viewed by this signer or null + * @param int|null $last_viewed_at The time that the document was last viewed by this signer or null. * * @return self */ - public function setLastViewedAt(?int $last_viewed_at) + public function setLastViewedAt($last_viewed_at) { if (is_null($last_viewed_at)) { array_push($this->openAPINullablesSetToNull, 'last_viewed_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('last_viewed_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -754,18 +768,18 @@ public function getLastRemindedAt() /** * Sets last_reminded_at * - * @param int|null $last_reminded_at the time the last reminder email was sent to the signer or null + * @param int|null $last_reminded_at The time the last reminder email was sent to the signer or null. * * @return self */ - public function setLastRemindedAt(?int $last_reminded_at) + public function setLastRemindedAt($last_reminded_at) { if (is_null($last_reminded_at)) { array_push($this->openAPINullablesSetToNull, 'last_reminded_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('last_reminded_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -788,14 +802,14 @@ public function getHasPin() /** * Sets has_pin * - * @param bool|null $has_pin boolean to indicate whether this signature requires a PIN to access + * @param bool|null $has_pin Boolean to indicate whether this signature requires a PIN to access. * * @return self */ - public function setHasPin(?bool $has_pin) + public function setHasPin($has_pin) { if (is_null($has_pin)) { - throw new InvalidArgumentException('non-nullable has_pin cannot be null'); + throw new \InvalidArgumentException('non-nullable has_pin cannot be null'); } $this->container['has_pin'] = $has_pin; @@ -815,18 +829,18 @@ public function getHasSmsAuth() /** * Sets has_sms_auth * - * @param bool|null $has_sms_auth boolean to indicate whether this signature has SMS authentication enabled + * @param bool|null $has_sms_auth Boolean to indicate whether this signature has SMS authentication enabled. * * @return self */ - public function setHasSmsAuth(?bool $has_sms_auth) + public function setHasSmsAuth($has_sms_auth) { if (is_null($has_sms_auth)) { array_push($this->openAPINullablesSetToNull, 'has_sms_auth'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('has_sms_auth', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -849,18 +863,18 @@ public function getHasSmsDelivery() /** * Sets has_sms_delivery * - * @param bool|null $has_sms_delivery boolean to indicate whether this signature has SMS delivery enabled + * @param bool|null $has_sms_delivery Boolean to indicate whether this signature has SMS delivery enabled. * * @return self */ - public function setHasSmsDelivery(?bool $has_sms_delivery) + public function setHasSmsDelivery($has_sms_delivery) { if (is_null($has_sms_delivery)) { array_push($this->openAPINullablesSetToNull, 'has_sms_delivery'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('has_sms_delivery', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -883,18 +897,18 @@ public function getSmsPhoneNumber() /** * Sets sms_phone_number * - * @param string|null $sms_phone_number the SMS phone number used for authentication or signature request delivery + * @param string|null $sms_phone_number The SMS phone number used for authentication or signature request delivery. * * @return self */ - public function setSmsPhoneNumber(?string $sms_phone_number) + public function setSmsPhoneNumber($sms_phone_number) { if (is_null($sms_phone_number)) { array_push($this->openAPINullablesSetToNull, 'sms_phone_number'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('sms_phone_number', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -917,18 +931,18 @@ public function getReassignedBy() /** * Sets reassigned_by * - * @param string|null $reassigned_by email address of original signer who reassigned to this signer + * @param string|null $reassigned_by Email address of original signer who reassigned to this signer. * * @return self */ - public function setReassignedBy(?string $reassigned_by) + public function setReassignedBy($reassigned_by) { if (is_null($reassigned_by)) { array_push($this->openAPINullablesSetToNull, 'reassigned_by'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('reassigned_by', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -951,18 +965,18 @@ public function getReassignmentReason() /** * Sets reassignment_reason * - * @param string|null $reassignment_reason reason provided by original signer who reassigned to this signer + * @param string|null $reassignment_reason Reason provided by original signer who reassigned to this signer. * * @return self */ - public function setReassignmentReason(?string $reassignment_reason) + public function setReassignmentReason($reassignment_reason) { if (is_null($reassignment_reason)) { array_push($this->openAPINullablesSetToNull, 'reassignment_reason'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('reassignment_reason', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -985,18 +999,18 @@ public function getReassignedFrom() /** * Sets reassigned_from * - * @param string|null $reassigned_from previous signature identifier + * @param string|null $reassigned_from Previous signature identifier. * * @return self */ - public function setReassignedFrom(?string $reassigned_from) + public function setReassignedFrom($reassigned_from) { if (is_null($reassigned_from)) { array_push($this->openAPINullablesSetToNull, 'reassigned_from'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('reassigned_from', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1019,18 +1033,18 @@ public function getError() /** * Sets error * - * @param string|null $error error message pertaining to this signer, or null + * @param string|null $error Error message pertaining to this signer, or null. * * @return self */ - public function setError(?string $error) + public function setError($error) { if (is_null($error)) { array_push($this->openAPINullablesSetToNull, 'error'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('error', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1039,13 +1053,14 @@ public function setError(?string $error) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1054,11 +1069,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1069,8 +1084,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1083,9 +1100,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1093,15 +1112,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1127,3 +1146,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestSendRequest.php b/sdks/php/src/Model/SignatureRequestSendRequest.php index 600ee133e..af3da3936 100644 --- a/sdks/php/src/Model/SignatureRequestSendRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestSendRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestSendRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'files' => '\SplFileObject[]', 'file_urls' => 'string[]', @@ -83,16 +83,16 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => 'bool', 'title' => 'string', 'use_text_tags' => 'bool', - 'expires_at' => 'int', + 'expires_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'files' => 'binary', 'file_urls' => null, @@ -119,14 +119,14 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => null, 'title' => null, 'use_text_tags' => null, - 'expires_at' => null, + 'expires_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'files' => false, 'file_urls' => false, @@ -153,14 +153,14 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => false, 'title' => false, 'use_text_tags' => false, - 'expires_at' => true, + 'expires_at' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -185,6 +185,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -194,7 +196,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -204,7 +206,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -213,6 +215,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -221,6 +226,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -259,7 +267,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'use_text_tags' => 'use_text_tags', - 'expires_at' => 'expires_at', + 'expires_at' => 'expires_at' ]; /** @@ -293,7 +301,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', - 'expires_at' => 'setExpiresAt', + 'expires_at' => 'setExpiresAt' ]; /** @@ -327,7 +335,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', - 'expires_at' => 'getExpiresAt', + 'expires_at' => 'getExpiresAt' ]; /** @@ -371,6 +379,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -414,33 +423,34 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestSendRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestSendRequest { /** @var SignatureRequestSendRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestSendRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -485,10 +495,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -498,14 +509,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -529,10 +540,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -542,7 +553,7 @@ public function setFileUrls(?array $file_urls) /** * Gets signers * - * @return SubSignatureRequestSigner[]|null + * @return \Dropbox\Sign\Model\SubSignatureRequestSigner[]|null */ public function getSigners() { @@ -552,14 +563,14 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param \Dropbox\Sign\Model\SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. * * @return self */ - public function setSigners(?array $signers) + public function setSigners($signers) { if (is_null($signers)) { - throw new InvalidArgumentException('non-nullable signers cannot be null'); + throw new \InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -569,7 +580,7 @@ public function setSigners(?array $signers) /** * Gets grouped_signers * - * @return SubSignatureRequestGroupedSigners[]|null + * @return \Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]|null */ public function getGroupedSigners() { @@ -579,14 +590,14 @@ public function getGroupedSigners() /** * Sets grouped_signers * - * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param \Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. * * @return self */ - public function setGroupedSigners(?array $grouped_signers) + public function setGroupedSigners($grouped_signers) { if (is_null($grouped_signers)) { - throw new InvalidArgumentException('non-nullable grouped_signers cannot be null'); + throw new \InvalidArgumentException('non-nullable grouped_signers cannot be null'); } $this->container['grouped_signers'] = $grouped_signers; @@ -610,10 +621,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline(?bool $allow_decline) + public function setAllowDecline($allow_decline) { if (is_null($allow_decline)) { - throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -637,10 +648,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign(?bool $allow_reassign) + public function setAllowReassign($allow_reassign) { if (is_null($allow_reassign)) { - throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -650,7 +661,7 @@ public function setAllowReassign(?bool $allow_reassign) /** * Gets attachments * - * @return SubAttachment[]|null + * @return \Dropbox\Sign\Model\SubAttachment[]|null */ public function getAttachments() { @@ -660,14 +671,14 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments(?array $attachments) + public function setAttachments($attachments) { if (is_null($attachments)) { - throw new InvalidArgumentException('non-nullable attachments cannot be null'); + throw new \InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -687,14 +698,14 @@ public function getCcEmailAddresses() /** * Sets cc_email_addresses * - * @param string[]|null $cc_email_addresses the email addresses that should be CCed + * @param string[]|null $cc_email_addresses The email addresses that should be CCed. * * @return self */ - public function setCcEmailAddresses(?array $cc_email_addresses) + public function setCcEmailAddresses($cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -718,10 +729,10 @@ public function getClientId() * * @return self */ - public function setClientId(?string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -731,7 +742,7 @@ public function setClientId(?string $client_id) /** * Gets custom_fields * - * @return SubCustomField[]|null + * @return \Dropbox\Sign\Model\SubCustomField[]|null */ public function getCustomFields() { @@ -741,14 +752,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -758,7 +769,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets field_options * - * @return SubFieldOptions|null + * @return \Dropbox\Sign\Model\SubFieldOptions|null */ public function getFieldOptions() { @@ -768,14 +779,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param SubFieldOptions|null $field_options field_options + * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions(?SubFieldOptions $field_options) + public function setFieldOptions($field_options) { if (is_null($field_options)) { - throw new InvalidArgumentException('non-nullable field_options cannot be null'); + throw new \InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -785,7 +796,7 @@ public function setFieldOptions(?SubFieldOptions $field_options) /** * Gets form_field_groups * - * @return SubFormFieldGroup[]|null + * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -795,14 +806,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups(?array $form_field_groups) + public function setFormFieldGroups($form_field_groups) { if (is_null($form_field_groups)) { - throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -812,7 +823,7 @@ public function setFormFieldGroups(?array $form_field_groups) /** * Gets form_field_rules * - * @return SubFormFieldRule[]|null + * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -822,14 +833,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` + * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. * * @return self */ - public function setFormFieldRules(?array $form_field_rules) + public function setFormFieldRules($form_field_rules) { if (is_null($form_field_rules)) { - throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -839,7 +850,7 @@ public function setFormFieldRules(?array $form_field_rules) /** * Gets form_fields_per_document * - * @return SubFormFieldsPerDocumentBase[]|null + * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null */ public function getFormFieldsPerDocument() { @@ -849,14 +860,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument(?array $form_fields_per_document) + public function setFormFieldsPerDocument($form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -880,10 +891,10 @@ public function getHideTextTags() * * @return self */ - public function setHideTextTags(?bool $hide_text_tags) + public function setHideTextTags($hide_text_tags) { if (is_null($hide_text_tags)) { - throw new InvalidArgumentException('non-nullable hide_text_tags cannot be null'); + throw new \InvalidArgumentException('non-nullable hide_text_tags cannot be null'); } $this->container['hide_text_tags'] = $hide_text_tags; @@ -909,10 +920,10 @@ public function getIsQualifiedSignature() * @return self * @deprecated */ - public function setIsQualifiedSignature(?bool $is_qualified_signature) + public function setIsQualifiedSignature($is_qualified_signature) { if (is_null($is_qualified_signature)) { - throw new InvalidArgumentException('non-nullable is_qualified_signature cannot be null'); + throw new \InvalidArgumentException('non-nullable is_qualified_signature cannot be null'); } $this->container['is_qualified_signature'] = $is_qualified_signature; @@ -936,10 +947,10 @@ public function getIsEid() * * @return self */ - public function setIsEid(?bool $is_eid) + public function setIsEid($is_eid) { if (is_null($is_eid)) { - throw new InvalidArgumentException('non-nullable is_eid cannot be null'); + throw new \InvalidArgumentException('non-nullable is_eid cannot be null'); } $this->container['is_eid'] = $is_eid; @@ -959,17 +970,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that will be sent to the signers + * @param string|null $message The custom message in the email that will be sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestSendRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestSendRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -994,12 +1005,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -1008,7 +1020,7 @@ public function setMetadata(?array $metadata) /** * Gets signing_options * - * @return SubSigningOptions|null + * @return \Dropbox\Sign\Model\SubSigningOptions|null */ public function getSigningOptions() { @@ -1018,14 +1030,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param SubSigningOptions|null $signing_options signing_options + * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions(?SubSigningOptions $signing_options) + public function setSigningOptions($signing_options) { if (is_null($signing_options)) { - throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -1045,14 +1057,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -1072,17 +1084,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that will be sent to the signers + * @param string|null $subject The subject in the email that will be sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 255) { - throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestSendRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($subject) > 255)) { + throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestSendRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -1107,10 +1119,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1130,17 +1142,17 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title you want to assign to the SignatureRequest + * @param string|null $title The title you want to assign to the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } - if (mb_strlen($title) > 255) { - throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestSendRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($title) > 255)) { + throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestSendRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; @@ -1165,10 +1177,10 @@ public function getUseTextTags() * * @return self */ - public function setUseTextTags(?bool $use_text_tags) + public function setUseTextTags($use_text_tags) { if (is_null($use_text_tags)) { - throw new InvalidArgumentException('non-nullable use_text_tags cannot be null'); + throw new \InvalidArgumentException('non-nullable use_text_tags cannot be null'); } $this->container['use_text_tags'] = $use_text_tags; @@ -1192,14 +1204,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1208,13 +1220,14 @@ public function setExpiresAt(?int $expires_at) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1223,11 +1236,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1238,8 +1251,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1252,9 +1267,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1262,15 +1279,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1296,3 +1313,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php index c58096632..814d801f6 100644 --- a/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,37 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestSendWithTemplateRequest Class Doc Comment * * @category Class - * @description - * @see https://openapi-generator.tech + * @description + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestSendWithTemplateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_ids' => 'string[]', 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]', @@ -75,16 +75,16 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'signing_redirect_url' => 'string', 'subject' => 'string', 'test_mode' => 'bool', - 'title' => 'string', + 'title' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_ids' => null, 'signers' => null, @@ -102,14 +102,14 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'signing_redirect_url' => null, 'subject' => null, 'test_mode' => null, - 'title' => null, + 'title' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'template_ids' => false, 'signers' => false, @@ -127,14 +127,14 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'signing_redirect_url' => false, 'subject' => false, 'test_mode' => false, - 'title' => false, + 'title' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -159,6 +159,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -168,7 +170,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -178,7 +180,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -187,6 +189,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -195,6 +200,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -224,7 +232,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'signing_redirect_url', 'subject' => 'subject', 'test_mode' => 'test_mode', - 'title' => 'title', + 'title' => 'title' ]; /** @@ -249,7 +257,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'setSigningRedirectUrl', 'subject' => 'setSubject', 'test_mode' => 'setTestMode', - 'title' => 'setTitle', + 'title' => 'setTitle' ]; /** @@ -274,7 +282,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'getSigningRedirectUrl', 'subject' => 'getSubject', 'test_mode' => 'getTestMode', - 'title' => 'getTitle', + 'title' => 'getTitle' ]; /** @@ -318,6 +326,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -352,33 +361,34 @@ public function __construct(array $data = null) $this->setIfExists('title', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestSendWithTemplateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestSendWithTemplateRequest { /** @var SignatureRequestSendWithTemplateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestSendWithTemplateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -429,6 +439,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template_ids * @@ -442,14 +453,14 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used + * @param string[] $template_ids Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. * * @return self */ - public function setTemplateIds(array $template_ids) + public function setTemplateIds($template_ids) { if (is_null($template_ids)) { - throw new InvalidArgumentException('non-nullable template_ids cannot be null'); + throw new \InvalidArgumentException('non-nullable template_ids cannot be null'); } $this->container['template_ids'] = $template_ids; @@ -459,7 +470,7 @@ public function setTemplateIds(array $template_ids) /** * Gets signers * - * @return SubSignatureRequestTemplateSigner[] + * @return \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[] */ public function getSigners() { @@ -469,14 +480,14 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestTemplateSigner[] $signers add Signers to your Templated-based Signature Request + * @param \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[] $signers Add Signers to your Templated-based Signature Request. * * @return self */ - public function setSigners(array $signers) + public function setSigners($signers) { if (is_null($signers)) { - throw new InvalidArgumentException('non-nullable signers cannot be null'); + throw new \InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -500,10 +511,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline(?bool $allow_decline) + public function setAllowDecline($allow_decline) { if (is_null($allow_decline)) { - throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -513,7 +524,7 @@ public function setAllowDecline(?bool $allow_decline) /** * Gets ccs * - * @return SubCC[]|null + * @return \Dropbox\Sign\Model\SubCC[]|null */ public function getCcs() { @@ -523,14 +534,14 @@ public function getCcs() /** * Sets ccs * - * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * @param \Dropbox\Sign\Model\SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. * * @return self */ - public function setCcs(?array $ccs) + public function setCcs($ccs) { if (is_null($ccs)) { - throw new InvalidArgumentException('non-nullable ccs cannot be null'); + throw new \InvalidArgumentException('non-nullable ccs cannot be null'); } $this->container['ccs'] = $ccs; @@ -554,10 +565,10 @@ public function getClientId() * * @return self */ - public function setClientId(?string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -567,7 +578,7 @@ public function setClientId(?string $client_id) /** * Gets custom_fields * - * @return SubCustomField[]|null + * @return \Dropbox\Sign\Model\SubCustomField[]|null */ public function getCustomFields() { @@ -577,14 +588,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. + * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -594,7 +605,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -604,14 +615,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -635,10 +646,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -664,10 +675,10 @@ public function getIsQualifiedSignature() * @return self * @deprecated */ - public function setIsQualifiedSignature(?bool $is_qualified_signature) + public function setIsQualifiedSignature($is_qualified_signature) { if (is_null($is_qualified_signature)) { - throw new InvalidArgumentException('non-nullable is_qualified_signature cannot be null'); + throw new \InvalidArgumentException('non-nullable is_qualified_signature cannot be null'); } $this->container['is_qualified_signature'] = $is_qualified_signature; @@ -691,10 +702,10 @@ public function getIsEid() * * @return self */ - public function setIsEid(?bool $is_eid) + public function setIsEid($is_eid) { if (is_null($is_eid)) { - throw new InvalidArgumentException('non-nullable is_eid cannot be null'); + throw new \InvalidArgumentException('non-nullable is_eid cannot be null'); } $this->container['is_eid'] = $is_eid; @@ -714,17 +725,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that will be sent to the signers + * @param string|null $message The custom message in the email that will be sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -749,12 +760,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -763,7 +775,7 @@ public function setMetadata(?array $metadata) /** * Gets signing_options * - * @return SubSigningOptions|null + * @return \Dropbox\Sign\Model\SubSigningOptions|null */ public function getSigningOptions() { @@ -773,14 +785,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param SubSigningOptions|null $signing_options signing_options + * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions(?SubSigningOptions $signing_options) + public function setSigningOptions($signing_options) { if (is_null($signing_options)) { - throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -800,14 +812,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -827,17 +839,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that will be sent to the signers + * @param string|null $subject The subject in the email that will be sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 255) { - throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($subject) > 255)) { + throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -862,10 +874,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -885,30 +897,31 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title you want to assign to the SignatureRequest + * @param string|null $title The title you want to assign to the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } - if (mb_strlen($title) > 255) { - throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($title) > 255)) { + throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -917,11 +930,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -932,8 +945,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -946,9 +961,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -956,15 +973,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -990,3 +1007,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SignatureRequestUpdateRequest.php b/sdks/php/src/Model/SignatureRequestUpdateRequest.php index 2a4a33dcf..a2ae1ddc3 100644 --- a/sdks/php/src/Model/SignatureRequestUpdateRequest.php +++ b/sdks/php/src/Model/SignatureRequestUpdateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestUpdateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class SignatureRequestUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestUpdateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'signature_id' => 'string', 'email_address' => 'string', 'name' => 'string', - 'expires_at' => 'int', + 'expires_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'signature_id' => null, 'email_address' => 'email', 'name' => null, - 'expires_at' => null, + 'expires_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'signature_id' => false, 'email_address' => false, 'name' => false, - 'expires_at' => true, + 'expires_at' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'signature_id', 'email_address' => 'email_address', 'name' => 'name', - 'expires_at' => 'expires_at', + 'expires_at' => 'expires_at' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'setSignatureId', 'email_address' => 'setEmailAddress', 'name' => 'setName', - 'expires_at' => 'setExpiresAt', + 'expires_at' => 'setExpiresAt' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'getSignatureId', 'email_address' => 'getEmailAddress', 'name' => 'getName', - 'expires_at' => 'getExpiresAt', + 'expires_at' => 'getExpiresAt' ]; /** @@ -238,6 +247,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -259,33 +269,34 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SignatureRequestUpdateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SignatureRequestUpdateRequest { /** @var SignatureRequestUpdateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SignatureRequestUpdateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -321,6 +332,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets signature_id * @@ -334,14 +346,14 @@ public function getSignatureId() /** * Sets signature_id * - * @param string $signature_id the signature ID for the recipient + * @param string $signature_id The signature ID for the recipient. * * @return self */ - public function setSignatureId(string $signature_id) + public function setSignatureId($signature_id) { if (is_null($signature_id)) { - throw new InvalidArgumentException('non-nullable signature_id cannot be null'); + throw new \InvalidArgumentException('non-nullable signature_id cannot be null'); } $this->container['signature_id'] = $signature_id; @@ -365,10 +377,10 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -392,10 +404,10 @@ public function getName() * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -419,14 +431,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -435,13 +447,14 @@ public function setExpiresAt(?int $expires_at) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -450,11 +463,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -465,8 +478,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -479,9 +494,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -489,15 +506,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -523,3 +540,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubAttachment.php b/sdks/php/src/Model/SubAttachment.php index d41f3459c..4d2bdc89c 100644 --- a/sdks/php/src/Model/SubAttachment.php +++ b/sdks/php/src/Model/SubAttachment.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubAttachment Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubAttachment implements ModelInterface, ArrayAccess, JsonSerializable +class SubAttachment implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubAttachment'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', 'signer_index' => 'int', 'instructions' => 'string', - 'required' => 'bool', + 'required' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, 'signer_index' => null, 'instructions' => null, - 'required' => null, + 'required' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'name' => false, 'signer_index' => false, 'instructions' => false, - 'required' => false, + 'required' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'signer_index' => 'signer_index', 'instructions' => 'instructions', - 'required' => 'required', + 'required' => 'required' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'signer_index' => 'setSignerIndex', 'instructions' => 'setInstructions', - 'required' => 'setRequired', + 'required' => 'setRequired' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'signer_index' => 'getSignerIndex', 'instructions' => 'getInstructions', - 'required' => 'getRequired', + 'required' => 'getRequired' ]; /** @@ -238,6 +247,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -259,33 +269,34 @@ public function __construct(array $data = null) $this->setIfExists('required', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubAttachment { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubAttachment { /** @var SubAttachment */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubAttachment::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -324,6 +335,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -337,14 +349,14 @@ public function getName() /** * Sets name * - * @param string $name the name of attachment + * @param string $name The name of attachment. * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -368,10 +380,10 @@ public function getSignerIndex() * * @return self */ - public function setSignerIndex(int $signer_index) + public function setSignerIndex($signer_index) { if (is_null($signer_index)) { - throw new InvalidArgumentException('non-nullable signer_index cannot be null'); + throw new \InvalidArgumentException('non-nullable signer_index cannot be null'); } $this->container['signer_index'] = $signer_index; @@ -391,14 +403,14 @@ public function getInstructions() /** * Sets instructions * - * @param string|null $instructions the instructions for uploading the attachment + * @param string|null $instructions The instructions for uploading the attachment. * * @return self */ - public function setInstructions(?string $instructions) + public function setInstructions($instructions) { if (is_null($instructions)) { - throw new InvalidArgumentException('non-nullable instructions cannot be null'); + throw new \InvalidArgumentException('non-nullable instructions cannot be null'); } $this->container['instructions'] = $instructions; @@ -418,26 +430,27 @@ public function getRequired() /** * Sets required * - * @param bool|null $required determines if the attachment must be uploaded + * @param bool|null $required Determines if the attachment must be uploaded. * * @return self */ - public function setRequired(?bool $required) + public function setRequired($required) { if (is_null($required)) { - throw new InvalidArgumentException('non-nullable required cannot be null'); + throw new \InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -446,11 +459,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -461,8 +474,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -475,9 +490,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -485,15 +502,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -519,3 +536,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubBulkSignerList.php b/sdks/php/src/Model/SubBulkSignerList.php index d9702bb7d..7e521412b 100644 --- a/sdks/php/src/Model/SubBulkSignerList.php +++ b/sdks/php/src/Model/SubBulkSignerList.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubBulkSignerList Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubBulkSignerList implements ModelInterface, ArrayAccess, JsonSerializable +class SubBulkSignerList implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubBulkSignerList'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'custom_fields' => '\Dropbox\Sign\Model\SubBulkSignerListCustomField[]', - 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]', + 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'custom_fields' => null, - 'signers' => null, + 'signers' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'custom_fields' => false, - 'signers' => false, + 'signers' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'custom_fields' => 'custom_fields', - 'signers' => 'signers', + 'signers' => 'signers' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'custom_fields' => 'setCustomFields', - 'signers' => 'setSigners', + 'signers' => 'setSigners' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'custom_fields' => 'getCustomFields', - 'signers' => 'getSigners', + 'signers' => 'getSigners' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('signers', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubBulkSignerList { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubBulkSignerList { /** @var SubBulkSignerList */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubBulkSignerList::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -288,7 +299,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -302,10 +315,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets custom_fields * - * @return SubBulkSignerListCustomField[]|null + * @return \Dropbox\Sign\Model\SubBulkSignerListCustomField[]|null */ public function getCustomFields() { @@ -315,14 +329,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SubBulkSignerListCustomField[]|null $custom_fields an array of custom field values + * @param \Dropbox\Sign\Model\SubBulkSignerListCustomField[]|null $custom_fields An array of custom field values. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -332,7 +346,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets signers * - * @return SubSignatureRequestTemplateSigner[]|null + * @return \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]|null */ public function getSigners() { @@ -342,26 +356,27 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestTemplateSigner[]|null $signers Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. Currently only templates with a single role are supported. All signers must have the same `role` value. + * @param \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]|null $signers Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. Currently only templates with a single role are supported. All signers must have the same `role` value. * * @return self */ - public function setSigners(?array $signers) + public function setSigners($signers) { if (is_null($signers)) { - throw new InvalidArgumentException('non-nullable signers cannot be null'); + throw new \InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -370,11 +385,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -385,8 +400,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -399,9 +416,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -409,15 +428,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -443,3 +462,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubBulkSignerListCustomField.php b/sdks/php/src/Model/SubBulkSignerListCustomField.php index 17f67ac95..3f71fd021 100644 --- a/sdks/php/src/Model/SubBulkSignerListCustomField.php +++ b/sdks/php/src/Model/SubBulkSignerListCustomField.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubBulkSignerListCustomField Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubBulkSignerListCustomField implements ModelInterface, ArrayAccess, JsonSerializable +class SubBulkSignerListCustomField implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubBulkSignerListCustomField'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', - 'value' => 'string', + 'value' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'name' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubBulkSignerListCustomField { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubBulkSignerListCustomField { /** @var SubBulkSignerListCustomField */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubBulkSignerListCustomField::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -310,6 +321,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -327,10 +339,10 @@ public function getName() * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -350,26 +362,27 @@ public function getValue() /** * Sets value * - * @param string $value the value of the custom field + * @param string $value The value of the custom field. * * @return self */ - public function setValue(string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -378,11 +391,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -393,8 +406,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -407,9 +422,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -417,15 +434,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -451,3 +468,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubCC.php b/sdks/php/src/Model/SubCC.php index 0380a3889..93aed7abe 100644 --- a/sdks/php/src/Model/SubCC.php +++ b/sdks/php/src/Model/SubCC.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubCC Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubCC implements ModelInterface, ArrayAccess, JsonSerializable +class SubCC implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubCC'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'role' => 'string', - 'email_address' => 'string', + 'email_address' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'role' => null, - 'email_address' => 'email', + 'email_address' => 'email' ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'role' => false, - 'email_address' => false, + 'email_address' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'role' => 'role', - 'email_address' => 'email_address', + 'email_address' => 'email_address' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'role' => 'setRole', - 'email_address' => 'setEmailAddress', + 'email_address' => 'setEmailAddress' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'role' => 'getRole', - 'email_address' => 'getEmailAddress', + 'email_address' => 'getEmailAddress' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubCC { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubCC { /** @var SubCC */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubCC::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -310,6 +321,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets role * @@ -327,10 +339,10 @@ public function getRole() * * @return self */ - public function setRole(string $role) + public function setRole($role) { if (is_null($role)) { - throw new InvalidArgumentException('non-nullable role cannot be null'); + throw new \InvalidArgumentException('non-nullable role cannot be null'); } $this->container['role'] = $role; @@ -350,26 +362,27 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address of the CC recipient + * @param string $email_address The email address of the CC recipient. * * @return self */ - public function setEmailAddress(string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -378,11 +391,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -393,8 +406,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -407,9 +422,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -417,15 +434,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -451,3 +468,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubCustomField.php b/sdks/php/src/Model/SubCustomField.php index e853f9eb1..1c774c664 100644 --- a/sdks/php/src/Model/SubCustomField.php +++ b/sdks/php/src/Model/SubCustomField.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,74 +29,73 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubCustomField Class Doc Comment * * @category Class * @description When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubCustomField implements ModelInterface, ArrayAccess, JsonSerializable +class SubCustomField implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubCustomField'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', 'editor' => 'string', 'required' => 'bool', - 'value' => 'string', + 'value' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, 'editor' => null, 'required' => null, - 'value' => null, + 'value' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'name' => false, 'editor' => false, 'required' => false, - 'value' => false, + 'value' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,6 +120,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -128,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -138,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -147,6 +150,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -155,6 +161,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'editor' => 'editor', 'required' => 'required', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'editor' => 'setEditor', 'required' => 'setRequired', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'editor' => 'getEditor', 'required' => 'getRequired', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -239,6 +248,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -260,33 +270,34 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubCustomField { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubCustomField { /** @var SubCustomField */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubCustomField::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -322,6 +333,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -339,10 +351,10 @@ public function getName() * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -366,10 +378,10 @@ public function getEditor() * * @return self */ - public function setEditor(?string $editor) + public function setEditor($editor) { if (is_null($editor)) { - throw new InvalidArgumentException('non-nullable editor cannot be null'); + throw new \InvalidArgumentException('non-nullable editor cannot be null'); } $this->container['editor'] = $editor; @@ -393,10 +405,10 @@ public function getRequired() * * @return self */ - public function setRequired(?bool $required) + public function setRequired($required) { if (is_null($required)) { - throw new InvalidArgumentException('non-nullable required cannot be null'); + throw new \InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -416,26 +428,27 @@ public function getValue() /** * Sets value * - * @param string|null $value the string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing + * @param string|null $value The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing. * * @return self */ - public function setValue(?string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -444,11 +457,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -459,8 +472,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -473,9 +488,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -483,15 +500,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -517,3 +534,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubEditorOptions.php b/sdks/php/src/Model/SubEditorOptions.php index cd15d5965..e1b2b7368 100644 --- a/sdks/php/src/Model/SubEditorOptions.php +++ b/sdks/php/src/Model/SubEditorOptions.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,68 +29,67 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubEditorOptions Class Doc Comment * * @category Class * @description This allows the requester to specify editor options when a preparing a document - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubEditorOptions implements ModelInterface, ArrayAccess, JsonSerializable +class SubEditorOptions implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubEditorOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'allow_edit_signers' => 'bool', - 'allow_edit_documents' => 'bool', + 'allow_edit_documents' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'allow_edit_signers' => null, - 'allow_edit_documents' => null, + 'allow_edit_documents' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'allow_edit_signers' => false, - 'allow_edit_documents' => false, + 'allow_edit_documents' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -163,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'allow_edit_signers' => 'allow_edit_signers', - 'allow_edit_documents' => 'allow_edit_documents', + 'allow_edit_documents' => 'allow_edit_documents' ]; /** @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'allow_edit_signers' => 'setAllowEditSigners', - 'allow_edit_documents' => 'setAllowEditDocuments', + 'allow_edit_documents' => 'setAllowEditDocuments' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'allow_edit_signers' => 'getAllowEditSigners', - 'allow_edit_documents' => 'getAllowEditDocuments', + 'allow_edit_documents' => 'getAllowEditDocuments' ]; /** @@ -227,6 +236,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -246,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('allow_edit_documents', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubEditorOptions { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubEditorOptions { /** @var SubEditorOptions */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubEditorOptions::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -289,7 +300,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -303,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets allow_edit_signers * @@ -320,10 +334,10 @@ public function getAllowEditSigners() * * @return self */ - public function setAllowEditSigners(?bool $allow_edit_signers) + public function setAllowEditSigners($allow_edit_signers) { if (is_null($allow_edit_signers)) { - throw new InvalidArgumentException('non-nullable allow_edit_signers cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_edit_signers cannot be null'); } $this->container['allow_edit_signers'] = $allow_edit_signers; @@ -347,22 +361,23 @@ public function getAllowEditDocuments() * * @return self */ - public function setAllowEditDocuments(?bool $allow_edit_documents) + public function setAllowEditDocuments($allow_edit_documents) { if (is_null($allow_edit_documents)) { - throw new InvalidArgumentException('non-nullable allow_edit_documents cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_edit_documents cannot be null'); } $this->container['allow_edit_documents'] = $allow_edit_documents; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -371,11 +386,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -386,8 +401,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -400,9 +417,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -410,15 +429,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -444,3 +463,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFieldOptions.php b/sdks/php/src/Model/SubFieldOptions.php index 974daa4a9..a48d02d16 100644 --- a/sdks/php/src/Model/SubFieldOptions.php +++ b/sdks/php/src/Model/SubFieldOptions.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,65 +29,64 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubFieldOptions Class Doc Comment * * @category Class * @description This allows the requester to specify field options for a signature request. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFieldOptions implements ModelInterface, ArrayAccess, JsonSerializable +class SubFieldOptions implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFieldOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'date_format' => 'string', + 'date_format' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'date_format' => null, + 'date_format' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'date_format' => false, + 'date_format' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -159,7 +168,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'date_format' => 'date_format', + 'date_format' => 'date_format' ]; /** @@ -168,7 +177,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'date_format' => 'setDateFormat', + 'date_format' => 'setDateFormat' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'date_format' => 'getDateFormat', + 'date_format' => 'getDateFormat' ]; /** @@ -263,33 +272,34 @@ public function __construct(array $data = null) $this->setIfExists('date_format', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFieldOptions { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFieldOptions { /** @var SubFieldOptions */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFieldOptions::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -334,6 +344,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets date_format * @@ -347,18 +358,18 @@ public function getDateFormat() /** * Sets date_format * - * @param string $date_format allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **NOTE:** Only available for Premium and higher + * @param string $date_format Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **NOTE:** Only available for Premium and higher. * * @return self */ - public function setDateFormat(string $date_format) + public function setDateFormat($date_format) { if (is_null($date_format)) { - throw new InvalidArgumentException('non-nullable date_format cannot be null'); + throw new \InvalidArgumentException('non-nullable date_format cannot be null'); } $allowedValues = $this->getDateFormatAllowableValues(); if (!in_array($date_format, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'date_format', must be one of '%s'", $date_format, @@ -370,13 +381,14 @@ public function setDateFormat(string $date_format) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -385,11 +397,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -400,8 +412,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -414,9 +428,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -424,15 +440,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -458,3 +474,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldGroup.php b/sdks/php/src/Model/SubFormFieldGroup.php index 2ff53e101..16756976f 100644 --- a/sdks/php/src/Model/SubFormFieldGroup.php +++ b/sdks/php/src/Model/SubFormFieldGroup.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldGroup Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFormFieldGroup implements ModelInterface, ArrayAccess, JsonSerializable +class SubFormFieldGroup implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldGroup'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'group_id' => 'string', 'group_label' => 'string', - 'requirement' => 'string', + 'requirement' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'group_id' => null, 'group_label' => null, - 'requirement' => null, + 'requirement' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'group_id' => false, 'group_label' => false, - 'requirement' => false, + 'requirement' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'group_id' => 'group_id', 'group_label' => 'group_label', - 'requirement' => 'requirement', + 'requirement' => 'requirement' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'group_id' => 'setGroupId', 'group_label' => 'setGroupLabel', - 'requirement' => 'setRequirement', + 'requirement' => 'setRequirement' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'group_id' => 'getGroupId', 'group_label' => 'getGroupLabel', - 'requirement' => 'getRequirement', + 'requirement' => 'getRequirement' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('requirement', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldGroup { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldGroup { /** @var SubFormFieldGroup */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldGroup::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -320,6 +331,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets group_id * @@ -337,10 +349,10 @@ public function getGroupId() * * @return self */ - public function setGroupId(string $group_id) + public function setGroupId($group_id) { if (is_null($group_id)) { - throw new InvalidArgumentException('non-nullable group_id cannot be null'); + throw new \InvalidArgumentException('non-nullable group_id cannot be null'); } $this->container['group_id'] = $group_id; @@ -364,10 +376,10 @@ public function getGroupLabel() * * @return self */ - public function setGroupLabel(string $group_label) + public function setGroupLabel($group_label) { if (is_null($group_label)) { - throw new InvalidArgumentException('non-nullable group_label cannot be null'); + throw new \InvalidArgumentException('non-nullable group_label cannot be null'); } $this->container['group_label'] = $group_label; @@ -391,22 +403,23 @@ public function getRequirement() * * @return self */ - public function setRequirement(string $requirement) + public function setRequirement($requirement) { if (is_null($requirement)) { - throw new InvalidArgumentException('non-nullable requirement cannot be null'); + throw new \InvalidArgumentException('non-nullable requirement cannot be null'); } $this->container['requirement'] = $requirement; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -415,11 +428,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -430,8 +443,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -444,9 +459,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -454,15 +471,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -488,3 +505,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldRule.php b/sdks/php/src/Model/SubFormFieldRule.php index 094d8217c..c571835bf 100644 --- a/sdks/php/src/Model/SubFormFieldRule.php +++ b/sdks/php/src/Model/SubFormFieldRule.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldRule Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFormFieldRule implements ModelInterface, ArrayAccess, JsonSerializable +class SubFormFieldRule implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldRule'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'id' => 'string', 'trigger_operator' => 'string', 'triggers' => '\Dropbox\Sign\Model\SubFormFieldRuleTrigger[]', - 'actions' => '\Dropbox\Sign\Model\SubFormFieldRuleAction[]', + 'actions' => '\Dropbox\Sign\Model\SubFormFieldRuleAction[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'id' => null, 'trigger_operator' => null, 'triggers' => null, - 'actions' => null, + 'actions' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'id' => false, 'trigger_operator' => false, 'triggers' => false, - 'actions' => false, + 'actions' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'id', 'trigger_operator' => 'trigger_operator', 'triggers' => 'triggers', - 'actions' => 'actions', + 'actions' => 'actions' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'setId', 'trigger_operator' => 'setTriggerOperator', 'triggers' => 'setTriggers', - 'actions' => 'setActions', + 'actions' => 'setActions' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'getId', 'trigger_operator' => 'getTriggerOperator', 'triggers' => 'getTriggers', - 'actions' => 'getActions', + 'actions' => 'getActions' ]; /** @@ -238,6 +247,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -259,33 +269,34 @@ public function __construct(array $data = null) $this->setIfExists('actions', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldRule { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldRule { /** @var SubFormFieldRule */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldRule::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -313,18 +324,18 @@ public function listInvalidProperties() if ($this->container['triggers'] === null) { $invalidProperties[] = "'triggers' can't be null"; } - if (count($this->container['triggers']) > 1) { + if ((count($this->container['triggers']) > 1)) { $invalidProperties[] = "invalid value for 'triggers', number of items must be less than or equal to 1."; } - if (count($this->container['triggers']) < 1) { + if ((count($this->container['triggers']) < 1)) { $invalidProperties[] = "invalid value for 'triggers', number of items must be greater than or equal to 1."; } if ($this->container['actions'] === null) { $invalidProperties[] = "'actions' can't be null"; } - if (count($this->container['actions']) < 1) { + if ((count($this->container['actions']) < 1)) { $invalidProperties[] = "invalid value for 'actions', number of items must be greater than or equal to 1."; } @@ -342,6 +353,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets id * @@ -355,14 +367,14 @@ public function getId() /** * Sets id * - * @param string $id must be unique across all defined rules + * @param string $id Must be unique across all defined rules. * * @return self */ - public function setId(string $id) + public function setId($id) { if (is_null($id)) { - throw new InvalidArgumentException('non-nullable id cannot be null'); + throw new \InvalidArgumentException('non-nullable id cannot be null'); } $this->container['id'] = $id; @@ -386,10 +398,10 @@ public function getTriggerOperator() * * @return self */ - public function setTriggerOperator(string $trigger_operator) + public function setTriggerOperator($trigger_operator) { if (is_null($trigger_operator)) { - throw new InvalidArgumentException('non-nullable trigger_operator cannot be null'); + throw new \InvalidArgumentException('non-nullable trigger_operator cannot be null'); } $this->container['trigger_operator'] = $trigger_operator; @@ -399,7 +411,7 @@ public function setTriggerOperator(string $trigger_operator) /** * Gets triggers * - * @return SubFormFieldRuleTrigger[] + * @return \Dropbox\Sign\Model\SubFormFieldRuleTrigger[] */ public function getTriggers() { @@ -409,21 +421,21 @@ public function getTriggers() /** * Sets triggers * - * @param SubFormFieldRuleTrigger[] $triggers An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed. + * @param \Dropbox\Sign\Model\SubFormFieldRuleTrigger[] $triggers An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed. * * @return self */ - public function setTriggers(array $triggers) + public function setTriggers($triggers) { if (is_null($triggers)) { - throw new InvalidArgumentException('non-nullable triggers cannot be null'); + throw new \InvalidArgumentException('non-nullable triggers cannot be null'); } - if (count($triggers) > 1) { - throw new InvalidArgumentException('invalid value for $triggers when calling SubFormFieldRule., number of items must be less than or equal to 1.'); + if ((count($triggers) > 1)) { + throw new \InvalidArgumentException('invalid value for $triggers when calling SubFormFieldRule., number of items must be less than or equal to 1.'); } - if (count($triggers) < 1) { - throw new InvalidArgumentException('invalid length for $triggers when calling SubFormFieldRule., number of items must be greater than or equal to 1.'); + if ((count($triggers) < 1)) { + throw new \InvalidArgumentException('invalid length for $triggers when calling SubFormFieldRule., number of items must be greater than or equal to 1.'); } $this->container['triggers'] = $triggers; @@ -433,7 +445,7 @@ public function setTriggers(array $triggers) /** * Gets actions * - * @return SubFormFieldRuleAction[] + * @return \Dropbox\Sign\Model\SubFormFieldRuleAction[] */ public function getActions() { @@ -443,30 +455,32 @@ public function getActions() /** * Sets actions * - * @param SubFormFieldRuleAction[] $actions An array of action definitions, the \"then that\" part of \"if this, **then that**\". Any number of actions may be attached to a single rule. + * @param \Dropbox\Sign\Model\SubFormFieldRuleAction[] $actions An array of action definitions, the \"then that\" part of \"if this, **then that**\". Any number of actions may be attached to a single rule. * * @return self */ - public function setActions(array $actions) + public function setActions($actions) { if (is_null($actions)) { - throw new InvalidArgumentException('non-nullable actions cannot be null'); + throw new \InvalidArgumentException('non-nullable actions cannot be null'); } - if (count($actions) < 1) { - throw new InvalidArgumentException('invalid length for $actions when calling SubFormFieldRule., number of items must be greater than or equal to 1.'); + + if ((count($actions) < 1)) { + throw new \InvalidArgumentException('invalid length for $actions when calling SubFormFieldRule., number of items must be greater than or equal to 1.'); } $this->container['actions'] = $actions; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -475,11 +489,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -490,8 +504,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -504,9 +520,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -514,15 +532,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -548,3 +566,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldRuleAction.php b/sdks/php/src/Model/SubFormFieldRuleAction.php index 458b5822f..bbc074c98 100644 --- a/sdks/php/src/Model/SubFormFieldRuleAction.php +++ b/sdks/php/src/Model/SubFormFieldRuleAction.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldRuleAction Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFormFieldRuleAction implements ModelInterface, ArrayAccess, JsonSerializable +class SubFormFieldRuleAction implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldRuleAction'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'hidden' => 'bool', 'type' => 'string', 'field_id' => 'string', - 'group_id' => 'string', + 'group_id' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'hidden' => null, 'type' => null, 'field_id' => null, - 'group_id' => null, + 'group_id' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'hidden' => false, 'type' => false, 'field_id' => false, - 'group_id' => false, + 'group_id' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'hidden' => 'hidden', 'type' => 'type', 'field_id' => 'field_id', - 'group_id' => 'group_id', + 'group_id' => 'group_id' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'hidden' => 'setHidden', 'type' => 'setType', 'field_id' => 'setFieldId', - 'group_id' => 'setGroupId', + 'group_id' => 'setGroupId' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'hidden' => 'getHidden', 'type' => 'getType', 'field_id' => 'getFieldId', - 'group_id' => 'getGroupId', + 'group_id' => 'getGroupId' ]; /** @@ -275,33 +284,34 @@ public function __construct(array $data = null) $this->setIfExists('group_id', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldRuleAction { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldRuleAction { /** @var SubFormFieldRuleAction */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldRuleAction::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -349,6 +359,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets hidden * @@ -362,14 +373,14 @@ public function getHidden() /** * Sets hidden * - * @param bool $hidden `true` to hide the target field when rule is satisfied, otherwise `false` + * @param bool $hidden `true` to hide the target field when rule is satisfied, otherwise `false`. * * @return self */ - public function setHidden(bool $hidden) + public function setHidden($hidden) { if (is_null($hidden)) { - throw new InvalidArgumentException('non-nullable hidden cannot be null'); + throw new \InvalidArgumentException('non-nullable hidden cannot be null'); } $this->container['hidden'] = $hidden; @@ -393,14 +404,14 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'type', must be one of '%s'", $type, @@ -430,10 +441,10 @@ public function getFieldId() * * @return self */ - public function setFieldId(?string $field_id) + public function setFieldId($field_id) { if (is_null($field_id)) { - throw new InvalidArgumentException('non-nullable field_id cannot be null'); + throw new \InvalidArgumentException('non-nullable field_id cannot be null'); } $this->container['field_id'] = $field_id; @@ -457,22 +468,23 @@ public function getGroupId() * * @return self */ - public function setGroupId(?string $group_id) + public function setGroupId($group_id) { if (is_null($group_id)) { - throw new InvalidArgumentException('non-nullable group_id cannot be null'); + throw new \InvalidArgumentException('non-nullable group_id cannot be null'); } $this->container['group_id'] = $group_id; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -481,11 +493,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -496,8 +508,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -510,9 +524,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -520,15 +536,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -554,3 +570,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldRuleTrigger.php b/sdks/php/src/Model/SubFormFieldRuleTrigger.php index 0ab5768e0..3f8b858cf 100644 --- a/sdks/php/src/Model/SubFormFieldRuleTrigger.php +++ b/sdks/php/src/Model/SubFormFieldRuleTrigger.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,73 +29,72 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldRuleTrigger Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFormFieldRuleTrigger implements ModelInterface, ArrayAccess, JsonSerializable +class SubFormFieldRuleTrigger implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldRuleTrigger'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'id' => 'string', 'operator' => 'string', 'value' => 'string', - 'values' => 'string[]', + 'values' => 'string[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'id' => null, 'operator' => null, 'value' => null, - 'values' => null, + 'values' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'id' => false, 'operator' => false, 'value' => false, - 'values' => false, + 'values' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -118,6 +119,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -127,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,6 +149,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -154,6 +160,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'id', 'operator' => 'operator', 'value' => 'value', - 'values' => 'values', + 'values' => 'values' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'setId', 'operator' => 'setOperator', 'value' => 'setValue', - 'values' => 'setValues', + 'values' => 'setValues' ]; /** @@ -194,7 +203,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'getId', 'operator' => 'getOperator', 'value' => 'getValue', - 'values' => 'getValues', + 'values' => 'getValues' ]; /** @@ -281,33 +290,34 @@ public function __construct(array $data = null) $this->setIfExists('values', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldRuleTrigger { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldRuleTrigger { /** @var SubFormFieldRuleTrigger */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldRuleTrigger::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -355,6 +365,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets id * @@ -372,10 +383,10 @@ public function getId() * * @return self */ - public function setId(string $id) + public function setId($id) { if (is_null($id)) { - throw new InvalidArgumentException('non-nullable id cannot be null'); + throw new \InvalidArgumentException('non-nullable id cannot be null'); } $this->container['id'] = $id; @@ -399,14 +410,14 @@ public function getOperator() * * @return self */ - public function setOperator(string $operator) + public function setOperator($operator) { if (is_null($operator)) { - throw new InvalidArgumentException('non-nullable operator cannot be null'); + throw new \InvalidArgumentException('non-nullable operator cannot be null'); } $allowedValues = $this->getOperatorAllowableValues(); if (!in_array($operator, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'operator', must be one of '%s'", $operator, @@ -436,10 +447,10 @@ public function getValue() * * @return self */ - public function setValue(?string $value) + public function setValue($value) { if (is_null($value)) { - throw new InvalidArgumentException('non-nullable value cannot be null'); + throw new \InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; @@ -463,22 +474,23 @@ public function getValues() * * @return self */ - public function setValues(?array $values) + public function setValues($values) { if (is_null($values)) { - throw new InvalidArgumentException('non-nullable values cannot be null'); + throw new \InvalidArgumentException('non-nullable values cannot be null'); } $this->container['values'] = $values; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -487,11 +499,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -502,8 +514,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -516,9 +530,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -526,15 +542,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -560,3 +576,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php b/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php index 68158bf5a..a6f4203d5 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentBase Class Doc Comment * * @category Class * @description The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFormFieldsPerDocumentBase implements ModelInterface, ArrayAccess, JsonSerializable +class SubFormFieldsPerDocumentBase implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'document_index' => 'int', 'api_id' => 'string', @@ -68,16 +69,16 @@ class SubFormFieldsPerDocumentBase implements ModelInterface, ArrayAccess, JsonS 'x' => 'int', 'y' => 'int', 'name' => 'string', - 'page' => 'int', + 'page' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'document_index' => null, 'api_id' => null, @@ -89,14 +90,14 @@ class SubFormFieldsPerDocumentBase implements ModelInterface, ArrayAccess, JsonS 'x' => null, 'y' => null, 'name' => null, - 'page' => null, + 'page' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'document_index' => false, 'api_id' => false, @@ -108,14 +109,14 @@ class SubFormFieldsPerDocumentBase implements ModelInterface, ArrayAccess, JsonS 'x' => false, 'y' => false, 'name' => false, - 'page' => true, + 'page' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -140,6 +141,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -149,7 +152,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -159,7 +162,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -168,6 +171,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -176,6 +182,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -199,7 +208,7 @@ public function isNullableSetToNull(string $property): bool 'x' => 'x', 'y' => 'y', 'name' => 'name', - 'page' => 'page', + 'page' => 'page' ]; /** @@ -218,7 +227,7 @@ public function isNullableSetToNull(string $property): bool 'x' => 'setX', 'y' => 'setY', 'name' => 'setName', - 'page' => 'setPage', + 'page' => 'setPage' ]; /** @@ -237,7 +246,7 @@ public function isNullableSetToNull(string $property): bool 'x' => 'getX', 'y' => 'getY', 'name' => 'getName', - 'page' => 'getPage', + 'page' => 'getPage' ]; /** @@ -281,6 +290,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -312,6 +322,7 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } + public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -353,12 +364,14 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -418,6 +431,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets document_index * @@ -431,14 +445,14 @@ public function getDocumentIndex() /** * Sets document_index * - * @param int $document_index represents the integer index of the `file` or `file_url` document the field should be attached to + * @param int $document_index Represents the integer index of the `file` or `file_url` document the field should be attached to. * * @return self */ - public function setDocumentIndex(int $document_index) + public function setDocumentIndex($document_index) { if (is_null($document_index)) { - throw new InvalidArgumentException('non-nullable document_index cannot be null'); + throw new \InvalidArgumentException('non-nullable document_index cannot be null'); } $this->container['document_index'] = $document_index; @@ -458,14 +472,14 @@ public function getApiId() /** * Sets api_id * - * @param string $api_id an identifier for the field that is unique across all documents in the request + * @param string $api_id An identifier for the field that is unique across all documents in the request. * * @return self */ - public function setApiId(string $api_id) + public function setApiId($api_id) { if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + throw new \InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -485,14 +499,14 @@ public function getHeight() /** * Sets height * - * @param int $height size of the field in pixels + * @param int $height Size of the field in pixels. * * @return self */ - public function setHeight(int $height) + public function setHeight($height) { if (is_null($height)) { - throw new InvalidArgumentException('non-nullable height cannot be null'); + throw new \InvalidArgumentException('non-nullable height cannot be null'); } $this->container['height'] = $height; @@ -512,14 +526,14 @@ public function getRequired() /** * Sets required * - * @param bool $required whether this field is required + * @param bool $required Whether this field is required. * * @return self */ - public function setRequired(bool $required) + public function setRequired($required) { if (is_null($required)) { - throw new InvalidArgumentException('non-nullable required cannot be null'); + throw new \InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -543,10 +557,10 @@ public function getSigner() * * @return self */ - public function setSigner(string $signer) + public function setSigner($signer) { if (is_null($signer)) { - throw new InvalidArgumentException('non-nullable signer cannot be null'); + throw new \InvalidArgumentException('non-nullable signer cannot be null'); } $this->container['signer'] = $signer; @@ -570,10 +584,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -593,14 +607,14 @@ public function getWidth() /** * Sets width * - * @param int $width size of the field in pixels + * @param int $width Size of the field in pixels. * * @return self */ - public function setWidth(int $width) + public function setWidth($width) { if (is_null($width)) { - throw new InvalidArgumentException('non-nullable width cannot be null'); + throw new \InvalidArgumentException('non-nullable width cannot be null'); } $this->container['width'] = $width; @@ -620,14 +634,14 @@ public function getX() /** * Sets x * - * @param int $x location coordinates of the field in pixels + * @param int $x Location coordinates of the field in pixels. * * @return self */ - public function setX(int $x) + public function setX($x) { if (is_null($x)) { - throw new InvalidArgumentException('non-nullable x cannot be null'); + throw new \InvalidArgumentException('non-nullable x cannot be null'); } $this->container['x'] = $x; @@ -647,14 +661,14 @@ public function getY() /** * Sets y * - * @param int $y location coordinates of the field in pixels + * @param int $y Location coordinates of the field in pixels. * * @return self */ - public function setY(int $y) + public function setY($y) { if (is_null($y)) { - throw new InvalidArgumentException('non-nullable y cannot be null'); + throw new \InvalidArgumentException('non-nullable y cannot be null'); } $this->container['y'] = $y; @@ -674,14 +688,14 @@ public function getName() /** * Sets name * - * @param string|null $name display name for the field + * @param string|null $name Display name for the field. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -705,14 +719,14 @@ public function getPage() * * @return self */ - public function setPage(?int $page) + public function setPage($page) { if (is_null($page)) { array_push($this->openAPINullablesSetToNull, 'page'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('page', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -721,13 +735,14 @@ public function setPage(?int $page) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -736,11 +751,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -751,8 +766,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -765,9 +782,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -775,15 +794,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -809,3 +828,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentCheckbox.php b/sdks/php/src/Model/SubFormFieldsPerDocumentCheckbox.php index c023916c7..770a00dbe 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentCheckbox.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentCheckbox.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentCheckbox Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentCheckbox extends SubFormFieldsPerDocumentBase @@ -44,52 +45,52 @@ class SubFormFieldsPerDocumentCheckbox extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'is_checked' => 'bool', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'is_checked' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'is_checked' => false, - 'group' => false, + 'group' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,6 +115,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -123,7 +126,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +136,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,6 +145,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -150,6 +156,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -165,7 +174,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'is_checked' => 'is_checked', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'is_checked' => 'setIsChecked', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -187,7 +196,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'is_checked' => 'getIsChecked', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -231,6 +240,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -246,33 +257,34 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldsPerDocumentCheckbox { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldsPerDocumentCheckbox { /** @var SubFormFieldsPerDocumentCheckbox */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentCheckbox::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -311,6 +323,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -328,10 +341,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -351,14 +364,14 @@ public function getIsChecked() /** * Sets is_checked * - * @param bool $is_checked `true` for checking the checkbox field by default, otherwise `false` + * @param bool $is_checked `true` for checking the checkbox field by default, otherwise `false`. * * @return self */ - public function setIsChecked(bool $is_checked) + public function setIsChecked($is_checked) { if (is_null($is_checked)) { - throw new InvalidArgumentException('non-nullable is_checked cannot be null'); + throw new \InvalidArgumentException('non-nullable is_checked cannot be null'); } $this->container['is_checked'] = $is_checked; @@ -378,26 +391,27 @@ public function getGroup() /** * Sets group * - * @param string|null $group string referencing group defined in `form_field_groups` parameter + * @param string|null $group String referencing group defined in `form_field_groups` parameter. * * @return self */ - public function setGroup(?string $group) + public function setGroup($group) { if (is_null($group)) { - throw new InvalidArgumentException('non-nullable group cannot be null'); + throw new \InvalidArgumentException('non-nullable group cannot be null'); } $this->container['group'] = $group; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -406,11 +420,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -421,8 +435,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -435,9 +451,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -445,15 +463,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -479,3 +497,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentCheckboxMerge.php b/sdks/php/src/Model/SubFormFieldsPerDocumentCheckboxMerge.php index c3924079b..24cddc531 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentCheckboxMerge.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentCheckboxMerge.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentCheckboxMerge Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentCheckboxMerge extends SubFormFieldsPerDocumentBase @@ -44,46 +45,46 @@ class SubFormFieldsPerDocumentCheckboxMerge extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentCheckboxMerge'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'checkbox-merge'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldsPerDocumentCheckboxMerge { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldsPerDocumentCheckboxMerge { /** @var SubFormFieldsPerDocumentCheckboxMerge */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentCheckboxMerge::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentDateSigned.php b/sdks/php/src/Model/SubFormFieldsPerDocumentDateSigned.php index 5902025ad..ee6ae9e8c 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentDateSigned.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentDateSigned.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentDateSigned Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentDateSigned extends SubFormFieldsPerDocumentBase @@ -44,52 +45,52 @@ class SubFormFieldsPerDocumentDateSigned extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentDateSigned'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'font_family' => 'string', - 'font_size' => 'int', + 'font_size' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'font_family' => null, - 'font_size' => null, + 'font_size' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'font_family' => false, - 'font_size' => false, + 'font_size' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,6 +115,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -123,7 +126,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +136,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,6 +145,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -150,6 +156,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -165,7 +174,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'font_family' => 'font_family', - 'font_size' => 'font_size', + 'font_size' => 'font_size' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'font_family' => 'setFontFamily', - 'font_size' => 'setFontSize', + 'font_size' => 'setFontSize' ]; /** @@ -187,7 +196,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'font_family' => 'getFontFamily', - 'font_size' => 'getFontSize', + 'font_size' => 'getFontSize' ]; /** @@ -275,6 +284,7 @@ public function getFontFamilyAllowableValues() ]; } + /** * Constructor * @@ -290,33 +300,34 @@ public function __construct(array $data = null) $this->setIfExists('font_size', $data ?? [], 12); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldsPerDocumentDateSigned { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldsPerDocumentDateSigned { /** @var SubFormFieldsPerDocumentDateSigned */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentDateSigned::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -361,6 +372,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -378,10 +390,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -401,18 +413,18 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family for the field + * @param string|null $font_family Font family for the field. * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily($font_family) { if (is_null($font_family)) { - throw new InvalidArgumentException('non-nullable font_family cannot be null'); + throw new \InvalidArgumentException('non-nullable font_family cannot be null'); } $allowedValues = $this->getFontFamilyAllowableValues(); if (!in_array($font_family, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'font_family', must be one of '%s'", $font_family, @@ -442,22 +454,23 @@ public function getFontSize() * * @return self */ - public function setFontSize(?int $font_size) + public function setFontSize($font_size) { if (is_null($font_size)) { - throw new InvalidArgumentException('non-nullable font_size cannot be null'); + throw new \InvalidArgumentException('non-nullable font_size cannot be null'); } $this->container['font_size'] = $font_size; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -466,11 +479,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -481,8 +494,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -495,9 +510,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -505,15 +522,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -539,3 +556,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentDropdown.php b/sdks/php/src/Model/SubFormFieldsPerDocumentDropdown.php index 121c3eb48..baf704962 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentDropdown.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentDropdown.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentDropdown Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentDropdown extends SubFormFieldsPerDocumentBase @@ -44,58 +45,58 @@ class SubFormFieldsPerDocumentDropdown extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentDropdown'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'options' => 'string[]', 'content' => 'string', 'font_family' => 'string', - 'font_size' => 'int', + 'font_size' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'options' => null, 'content' => null, 'font_family' => null, - 'font_size' => null, + 'font_size' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'options' => false, 'content' => false, 'font_family' => false, - 'font_size' => false, + 'font_size' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,6 +121,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -129,7 +132,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -139,7 +142,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -148,6 +151,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -156,6 +162,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'options' => 'options', 'content' => 'content', 'font_family' => 'font_family', - 'font_size' => 'font_size', + 'font_size' => 'font_size' ]; /** @@ -186,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'options' => 'setOptions', 'content' => 'setContent', 'font_family' => 'setFontFamily', - 'font_size' => 'setFontSize', + 'font_size' => 'setFontSize' ]; /** @@ -199,7 +208,7 @@ public function isNullableSetToNull(string $property): bool 'options' => 'getOptions', 'content' => 'getContent', 'font_family' => 'getFontFamily', - 'font_size' => 'getFontSize', + 'font_size' => 'getFontSize' ]; /** @@ -287,6 +296,7 @@ public function getFontFamilyAllowableValues() ]; } + /** * Constructor * @@ -304,33 +314,34 @@ public function __construct(array $data = null) $this->setIfExists('font_size', $data ?? [], 12); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldsPerDocumentDropdown { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldsPerDocumentDropdown { /** @var SubFormFieldsPerDocumentDropdown */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentDropdown::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -355,7 +366,7 @@ public function listInvalidProperties() if ($this->container['options'] === null) { $invalidProperties[] = "'options' can't be null"; } - if (count($this->container['options']) < 1) { + if ((count($this->container['options']) < 1)) { $invalidProperties[] = "invalid value for 'options', number of items must be greater than or equal to 1."; } @@ -382,6 +393,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -399,10 +411,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -422,18 +434,19 @@ public function getOptions() /** * Sets options * - * @param string[] $options array of string values representing dropdown values + * @param string[] $options Array of string values representing dropdown values. * * @return self */ - public function setOptions(array $options) + public function setOptions($options) { if (is_null($options)) { - throw new InvalidArgumentException('non-nullable options cannot be null'); + throw new \InvalidArgumentException('non-nullable options cannot be null'); } - if (count($options) < 1) { - throw new InvalidArgumentException('invalid length for $options when calling SubFormFieldsPerDocumentDropdown., number of items must be greater than or equal to 1.'); + + if ((count($options) < 1)) { + throw new \InvalidArgumentException('invalid length for $options when calling SubFormFieldsPerDocumentDropdown., number of items must be greater than or equal to 1.'); } $this->container['options'] = $options; @@ -457,10 +470,10 @@ public function getContent() * * @return self */ - public function setContent(?string $content) + public function setContent($content) { if (is_null($content)) { - throw new InvalidArgumentException('non-nullable content cannot be null'); + throw new \InvalidArgumentException('non-nullable content cannot be null'); } $this->container['content'] = $content; @@ -480,18 +493,18 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family for the field + * @param string|null $font_family Font family for the field. * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily($font_family) { if (is_null($font_family)) { - throw new InvalidArgumentException('non-nullable font_family cannot be null'); + throw new \InvalidArgumentException('non-nullable font_family cannot be null'); } $allowedValues = $this->getFontFamilyAllowableValues(); if (!in_array($font_family, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'font_family', must be one of '%s'", $font_family, @@ -521,22 +534,23 @@ public function getFontSize() * * @return self */ - public function setFontSize(?int $font_size) + public function setFontSize($font_size) { if (is_null($font_size)) { - throw new InvalidArgumentException('non-nullable font_size cannot be null'); + throw new \InvalidArgumentException('non-nullable font_size cannot be null'); } $this->container['font_size'] = $font_size; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -545,11 +559,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -560,8 +574,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -574,9 +590,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -584,15 +602,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -618,3 +636,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentFontEnum.php b/sdks/php/src/Model/SubFormFieldsPerDocumentFontEnum.php index bc0eff196..55b2d0bc3 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentFontEnum.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentFontEnum.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,12 +28,15 @@ */ namespace Dropbox\Sign\Model; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentFontEnum Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class SubFormFieldsPerDocumentFontEnum { @@ -92,7 +97,9 @@ public static function getAllowableEnumValues() self::NOTO_SERIF, self::NOTO_CJK_JP_REGULAR, self::NOTO_HEBREW_REGULAR, - self::NOTO_SAN_THAI_MERGED, + self::NOTO_SAN_THAI_MERGED ]; } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentHyperlink.php b/sdks/php/src/Model/SubFormFieldsPerDocumentHyperlink.php index 924429f26..3ffdf37fc 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentHyperlink.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentHyperlink.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentHyperlink Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentHyperlink extends SubFormFieldsPerDocumentBase @@ -44,58 +45,58 @@ class SubFormFieldsPerDocumentHyperlink extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentHyperlink'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'content' => 'string', 'content_url' => 'string', 'font_family' => 'string', - 'font_size' => 'int', + 'font_size' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'content' => null, 'content_url' => null, 'font_family' => null, - 'font_size' => null, + 'font_size' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'content' => false, 'content_url' => false, 'font_family' => false, - 'font_size' => false, + 'font_size' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,6 +121,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -129,7 +132,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -139,7 +142,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -148,6 +151,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -156,6 +162,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'content' => 'content', 'content_url' => 'content_url', 'font_family' => 'font_family', - 'font_size' => 'font_size', + 'font_size' => 'font_size' ]; /** @@ -186,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'content' => 'setContent', 'content_url' => 'setContentUrl', 'font_family' => 'setFontFamily', - 'font_size' => 'setFontSize', + 'font_size' => 'setFontSize' ]; /** @@ -199,7 +208,7 @@ public function isNullableSetToNull(string $property): bool 'content' => 'getContent', 'content_url' => 'getContentUrl', 'font_family' => 'getFontFamily', - 'font_size' => 'getFontSize', + 'font_size' => 'getFontSize' ]; /** @@ -287,6 +296,7 @@ public function getFontFamilyAllowableValues() ]; } + /** * Constructor * @@ -304,33 +314,34 @@ public function __construct(array $data = null) $this->setIfExists('font_size', $data ?? [], 12); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldsPerDocumentHyperlink { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldsPerDocumentHyperlink { /** @var SubFormFieldsPerDocumentHyperlink */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentHyperlink::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -381,6 +392,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -398,10 +410,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -421,14 +433,14 @@ public function getContent() /** * Sets content * - * @param string $content link Text + * @param string $content Link Text. * * @return self */ - public function setContent(string $content) + public function setContent($content) { if (is_null($content)) { - throw new InvalidArgumentException('non-nullable content cannot be null'); + throw new \InvalidArgumentException('non-nullable content cannot be null'); } $this->container['content'] = $content; @@ -448,14 +460,14 @@ public function getContentUrl() /** * Sets content_url * - * @param string $content_url link URL + * @param string $content_url Link URL. * * @return self */ - public function setContentUrl(string $content_url) + public function setContentUrl($content_url) { if (is_null($content_url)) { - throw new InvalidArgumentException('non-nullable content_url cannot be null'); + throw new \InvalidArgumentException('non-nullable content_url cannot be null'); } $this->container['content_url'] = $content_url; @@ -475,18 +487,18 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family for the field + * @param string|null $font_family Font family for the field. * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily($font_family) { if (is_null($font_family)) { - throw new InvalidArgumentException('non-nullable font_family cannot be null'); + throw new \InvalidArgumentException('non-nullable font_family cannot be null'); } $allowedValues = $this->getFontFamilyAllowableValues(); if (!in_array($font_family, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'font_family', must be one of '%s'", $font_family, @@ -516,22 +528,23 @@ public function getFontSize() * * @return self */ - public function setFontSize(?int $font_size) + public function setFontSize($font_size) { if (is_null($font_size)) { - throw new InvalidArgumentException('non-nullable font_size cannot be null'); + throw new \InvalidArgumentException('non-nullable font_size cannot be null'); } $this->container['font_size'] = $font_size; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -540,11 +553,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -555,8 +568,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -569,9 +584,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -579,15 +596,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -613,3 +630,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentInitials.php b/sdks/php/src/Model/SubFormFieldsPerDocumentInitials.php index cfddb0495..57a576b57 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentInitials.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentInitials.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentInitials Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentInitials extends SubFormFieldsPerDocumentBase @@ -44,46 +45,46 @@ class SubFormFieldsPerDocumentInitials extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentInitials'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'initials'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldsPerDocumentInitials { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldsPerDocumentInitials { /** @var SubFormFieldsPerDocumentInitials */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentInitials::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentRadio.php b/sdks/php/src/Model/SubFormFieldsPerDocumentRadio.php index b506baa56..59b12addf 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentRadio.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentRadio.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentRadio Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentRadio extends SubFormFieldsPerDocumentBase @@ -44,52 +45,52 @@ class SubFormFieldsPerDocumentRadio extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentRadio'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'group' => 'string', - 'is_checked' => 'bool', + 'is_checked' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'group' => null, - 'is_checked' => null, + 'is_checked' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'group' => false, - 'is_checked' => false, + 'is_checked' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,6 +115,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -123,7 +126,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +136,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,6 +145,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -150,6 +156,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -165,7 +174,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'group' => 'group', - 'is_checked' => 'is_checked', + 'is_checked' => 'is_checked' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'group' => 'setGroup', - 'is_checked' => 'setIsChecked', + 'is_checked' => 'setIsChecked' ]; /** @@ -187,7 +196,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'group' => 'getGroup', - 'is_checked' => 'getIsChecked', + 'is_checked' => 'getIsChecked' ]; /** @@ -231,6 +240,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -246,33 +257,34 @@ public function __construct(array $data = null) $this->setIfExists('is_checked', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldsPerDocumentRadio { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldsPerDocumentRadio { /** @var SubFormFieldsPerDocumentRadio */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentRadio::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,6 +326,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -331,10 +344,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -354,14 +367,14 @@ public function getGroup() /** * Sets group * - * @param string $group string referencing group defined in `form_field_groups` parameter + * @param string $group String referencing group defined in `form_field_groups` parameter. * * @return self */ - public function setGroup(string $group) + public function setGroup($group) { if (is_null($group)) { - throw new InvalidArgumentException('non-nullable group cannot be null'); + throw new \InvalidArgumentException('non-nullable group cannot be null'); } $this->container['group'] = $group; @@ -385,22 +398,23 @@ public function getIsChecked() * * @return self */ - public function setIsChecked(bool $is_checked) + public function setIsChecked($is_checked) { if (is_null($is_checked)) { - throw new InvalidArgumentException('non-nullable is_checked cannot be null'); + throw new \InvalidArgumentException('non-nullable is_checked cannot be null'); } $this->container['is_checked'] = $is_checked; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -409,11 +423,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -424,8 +438,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -438,9 +454,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -448,15 +466,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -482,3 +500,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentSignature.php b/sdks/php/src/Model/SubFormFieldsPerDocumentSignature.php index 37c6e7a15..39b39d14a 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentSignature.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentSignature.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentSignature Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentSignature extends SubFormFieldsPerDocumentBase @@ -44,46 +45,46 @@ class SubFormFieldsPerDocumentSignature extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentSignature'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'signature'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldsPerDocumentSignature { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldsPerDocumentSignature { /** @var SubFormFieldsPerDocumentSignature */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentSignature::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentText.php b/sdks/php/src/Model/SubFormFieldsPerDocumentText.php index fa048a12b..2fcedd43f 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentText.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentText.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentText Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase @@ -44,17 +45,17 @@ class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'placeholder' => 'string', @@ -66,16 +67,16 @@ class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase 'validation_custom_regex_format_label' => 'string', 'content' => 'string', 'font_family' => 'string', - 'font_size' => 'int', + 'font_size' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'placeholder' => null, @@ -87,14 +88,14 @@ class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase 'validation_custom_regex_format_label' => null, 'content' => null, 'font_family' => null, - 'font_size' => null, + 'font_size' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'placeholder' => false, @@ -106,14 +107,14 @@ class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase 'validation_custom_regex_format_label' => false, 'content' => false, 'font_family' => false, - 'font_size' => false, + 'font_size' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -138,6 +139,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -147,7 +150,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -157,7 +160,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -166,6 +169,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -174,6 +180,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -197,7 +206,7 @@ public function isNullableSetToNull(string $property): bool 'validation_custom_regex_format_label' => 'validation_custom_regex_format_label', 'content' => 'content', 'font_family' => 'font_family', - 'font_size' => 'font_size', + 'font_size' => 'font_size' ]; /** @@ -216,7 +225,7 @@ public function isNullableSetToNull(string $property): bool 'validation_custom_regex_format_label' => 'setValidationCustomRegexFormatLabel', 'content' => 'setContent', 'font_family' => 'setFontFamily', - 'font_size' => 'setFontSize', + 'font_size' => 'setFontSize' ]; /** @@ -235,7 +244,7 @@ public function isNullableSetToNull(string $property): bool 'validation_custom_regex_format_label' => 'getValidationCustomRegexFormatLabel', 'content' => 'getContent', 'font_family' => 'getFontFamily', - 'font_size' => 'getFontSize', + 'font_size' => 'getFontSize' ]; /** @@ -354,6 +363,7 @@ public function getFontFamilyAllowableValues() ]; } + /** * Constructor * @@ -377,33 +387,34 @@ public function __construct(array $data = null) $this->setIfExists('font_size', $data ?? [], 12); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldsPerDocumentText { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldsPerDocumentText { /** @var SubFormFieldsPerDocumentText */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentText::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -457,6 +468,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -474,10 +486,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -497,14 +509,14 @@ public function getPlaceholder() /** * Sets placeholder * - * @param string|null $placeholder placeholder value for text field + * @param string|null $placeholder Placeholder value for text field. * * @return self */ - public function setPlaceholder(?string $placeholder) + public function setPlaceholder($placeholder) { if (is_null($placeholder)) { - throw new InvalidArgumentException('non-nullable placeholder cannot be null'); + throw new \InvalidArgumentException('non-nullable placeholder cannot be null'); } $this->container['placeholder'] = $placeholder; @@ -528,10 +540,10 @@ public function getAutoFillType() * * @return self */ - public function setAutoFillType(?string $auto_fill_type) + public function setAutoFillType($auto_fill_type) { if (is_null($auto_fill_type)) { - throw new InvalidArgumentException('non-nullable auto_fill_type cannot be null'); + throw new \InvalidArgumentException('non-nullable auto_fill_type cannot be null'); } $this->container['auto_fill_type'] = $auto_fill_type; @@ -555,10 +567,10 @@ public function getLinkId() * * @return self */ - public function setLinkId(?string $link_id) + public function setLinkId($link_id) { if (is_null($link_id)) { - throw new InvalidArgumentException('non-nullable link_id cannot be null'); + throw new \InvalidArgumentException('non-nullable link_id cannot be null'); } $this->container['link_id'] = $link_id; @@ -582,10 +594,10 @@ public function getMasked() * * @return self */ - public function setMasked(?bool $masked) + public function setMasked($masked) { if (is_null($masked)) { - throw new InvalidArgumentException('non-nullable masked cannot be null'); + throw new \InvalidArgumentException('non-nullable masked cannot be null'); } $this->container['masked'] = $masked; @@ -609,14 +621,14 @@ public function getValidationType() * * @return self */ - public function setValidationType(?string $validation_type) + public function setValidationType($validation_type) { if (is_null($validation_type)) { - throw new InvalidArgumentException('non-nullable validation_type cannot be null'); + throw new \InvalidArgumentException('non-nullable validation_type cannot be null'); } $allowedValues = $this->getValidationTypeAllowableValues(); if (!in_array($validation_type, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'validation_type', must be one of '%s'", $validation_type, @@ -646,10 +658,10 @@ public function getValidationCustomRegex() * * @return self */ - public function setValidationCustomRegex(?string $validation_custom_regex) + public function setValidationCustomRegex($validation_custom_regex) { if (is_null($validation_custom_regex)) { - throw new InvalidArgumentException('non-nullable validation_custom_regex cannot be null'); + throw new \InvalidArgumentException('non-nullable validation_custom_regex cannot be null'); } $this->container['validation_custom_regex'] = $validation_custom_regex; @@ -673,10 +685,10 @@ public function getValidationCustomRegexFormatLabel() * * @return self */ - public function setValidationCustomRegexFormatLabel(?string $validation_custom_regex_format_label) + public function setValidationCustomRegexFormatLabel($validation_custom_regex_format_label) { if (is_null($validation_custom_regex_format_label)) { - throw new InvalidArgumentException('non-nullable validation_custom_regex_format_label cannot be null'); + throw new \InvalidArgumentException('non-nullable validation_custom_regex_format_label cannot be null'); } $this->container['validation_custom_regex_format_label'] = $validation_custom_regex_format_label; @@ -700,10 +712,10 @@ public function getContent() * * @return self */ - public function setContent(?string $content) + public function setContent($content) { if (is_null($content)) { - throw new InvalidArgumentException('non-nullable content cannot be null'); + throw new \InvalidArgumentException('non-nullable content cannot be null'); } $this->container['content'] = $content; @@ -723,18 +735,18 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family for the field + * @param string|null $font_family Font family for the field. * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily($font_family) { if (is_null($font_family)) { - throw new InvalidArgumentException('non-nullable font_family cannot be null'); + throw new \InvalidArgumentException('non-nullable font_family cannot be null'); } $allowedValues = $this->getFontFamilyAllowableValues(); if (!in_array($font_family, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'font_family', must be one of '%s'", $font_family, @@ -764,22 +776,23 @@ public function getFontSize() * * @return self */ - public function setFontSize(?int $font_size) + public function setFontSize($font_size) { if (is_null($font_size)) { - throw new InvalidArgumentException('non-nullable font_size cannot be null'); + throw new \InvalidArgumentException('non-nullable font_size cannot be null'); } $this->container['font_size'] = $font_size; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -788,11 +801,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -803,8 +816,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -817,9 +832,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -827,15 +844,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -861,3 +878,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php b/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php index bfe22420e..ead5e94b7 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentTextMerge Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentTextMerge extends SubFormFieldsPerDocumentBase @@ -44,52 +45,52 @@ class SubFormFieldsPerDocumentTextMerge extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentTextMerge'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'font_family' => 'string', - 'font_size' => 'int', + 'font_size' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'font_family' => null, - 'font_size' => null, + 'font_size' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'font_family' => false, - 'font_size' => false, + 'font_size' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,6 +115,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -123,7 +126,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +136,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,6 +145,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -150,6 +156,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -165,7 +174,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'font_family' => 'font_family', - 'font_size' => 'font_size', + 'font_size' => 'font_size' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'font_family' => 'setFontFamily', - 'font_size' => 'setFontSize', + 'font_size' => 'setFontSize' ]; /** @@ -187,7 +196,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'font_family' => 'getFontFamily', - 'font_size' => 'getFontSize', + 'font_size' => 'getFontSize' ]; /** @@ -275,6 +284,7 @@ public function getFontFamilyAllowableValues() ]; } + /** * Constructor * @@ -290,33 +300,34 @@ public function __construct(array $data = null) $this->setIfExists('font_size', $data ?? [], 12); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubFormFieldsPerDocumentTextMerge { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubFormFieldsPerDocumentTextMerge { /** @var SubFormFieldsPerDocumentTextMerge */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentTextMerge::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -361,6 +372,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -378,10 +390,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -401,18 +413,18 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family for the field + * @param string|null $font_family Font family for the field. * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily($font_family) { if (is_null($font_family)) { - throw new InvalidArgumentException('non-nullable font_family cannot be null'); + throw new \InvalidArgumentException('non-nullable font_family cannot be null'); } $allowedValues = $this->getFontFamilyAllowableValues(); if (!in_array($font_family, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'font_family', must be one of '%s'", $font_family, @@ -442,22 +454,23 @@ public function getFontSize() * * @return self */ - public function setFontSize(?int $font_size) + public function setFontSize($font_size) { if (is_null($font_size)) { - throw new InvalidArgumentException('non-nullable font_size cannot be null'); + throw new \InvalidArgumentException('non-nullable font_size cannot be null'); } $this->container['font_size'] = $font_size; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -466,11 +479,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -481,8 +494,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -495,9 +510,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -505,15 +522,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -539,3 +556,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentTypeEnum.php b/sdks/php/src/Model/SubFormFieldsPerDocumentTypeEnum.php index 4a4294f5e..90cbd6110 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentTypeEnum.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentTypeEnum.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,12 +28,15 @@ */ namespace Dropbox\Sign\Model; +use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentTypeEnum Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class SubFormFieldsPerDocumentTypeEnum { @@ -74,7 +79,9 @@ public static function getAllowableEnumValues() self::SIGNATURE, self::RADIO, self::TEXT, - self::TEXT_MERGE, + self::TEXT_MERGE ]; } } + + diff --git a/sdks/php/src/Model/SubMergeField.php b/sdks/php/src/Model/SubMergeField.php index 8631a07e4..8afe90857 100644 --- a/sdks/php/src/Model/SubMergeField.php +++ b/sdks/php/src/Model/SubMergeField.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubMergeField Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubMergeField implements ModelInterface, ArrayAccess, JsonSerializable +class SubMergeField implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubMergeField'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'name' => false, - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'type' => 'type', + 'type' => 'type' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -261,33 +270,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubMergeField { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubMergeField { /** @var SubMergeField */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubMergeField::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -335,6 +345,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -352,10 +363,10 @@ public function getName() * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -375,18 +386,18 @@ public function getType() /** * Sets type * - * @param string $type the type of merge field + * @param string $type The type of merge field. * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'type', must be one of '%s'", $type, @@ -398,13 +409,14 @@ public function setType(string $type) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -413,11 +425,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -428,8 +440,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -442,9 +456,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -452,15 +468,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -486,3 +502,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubOAuth.php b/sdks/php/src/Model/SubOAuth.php index 2bbf85547..1448e8c42 100644 --- a/sdks/php/src/Model/SubOAuth.php +++ b/sdks/php/src/Model/SubOAuth.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,68 +29,67 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubOAuth Class Doc Comment * * @category Class * @description OAuth related parameters. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubOAuth implements ModelInterface, ArrayAccess, JsonSerializable +class SubOAuth implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubOAuth'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'callback_url' => 'string', - 'scopes' => 'string[]', + 'scopes' => 'string[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'callback_url' => null, - 'scopes' => null, + 'scopes' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'callback_url' => false, - 'scopes' => false, + 'scopes' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -163,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'callback_url' => 'callback_url', - 'scopes' => 'scopes', + 'scopes' => 'scopes' ]; /** @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'callback_url' => 'setCallbackUrl', - 'scopes' => 'setScopes', + 'scopes' => 'setScopes' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'callback_url' => 'getCallbackUrl', - 'scopes' => 'getScopes', + 'scopes' => 'getScopes' ]; /** @@ -274,33 +283,34 @@ public function __construct(array $data = null) $this->setIfExists('scopes', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubOAuth { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubOAuth { /** @var SubOAuth */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubOAuth::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,7 +327,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -331,6 +343,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets callback_url * @@ -348,10 +361,10 @@ public function getCallbackUrl() * * @return self */ - public function setCallbackUrl(?string $callback_url) + public function setCallbackUrl($callback_url) { if (is_null($callback_url)) { - throw new InvalidArgumentException('non-nullable callback_url cannot be null'); + throw new \InvalidArgumentException('non-nullable callback_url cannot be null'); } $this->container['callback_url'] = $callback_url; @@ -375,14 +388,14 @@ public function getScopes() * * @return self */ - public function setScopes(?array $scopes) + public function setScopes($scopes) { if (is_null($scopes)) { - throw new InvalidArgumentException('non-nullable scopes cannot be null'); + throw new \InvalidArgumentException('non-nullable scopes cannot be null'); } $allowedValues = $this->getScopesAllowableValues(); if (array_diff($scopes, $allowedValues)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value for 'scopes', must be one of '%s'", implode("', '", $allowedValues) @@ -393,13 +406,14 @@ public function setScopes(?array $scopes) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -408,11 +422,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -423,8 +437,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -437,9 +453,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -447,15 +465,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -481,3 +499,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubOptions.php b/sdks/php/src/Model/SubOptions.php index b86fa5b7f..13bfa09ef 100644 --- a/sdks/php/src/Model/SubOptions.php +++ b/sdks/php/src/Model/SubOptions.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,65 +29,64 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubOptions Class Doc Comment * * @category Class * @description Additional options supported by API App. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubOptions implements ModelInterface, ArrayAccess, JsonSerializable +class SubOptions implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'can_insert_everywhere' => 'bool', + 'can_insert_everywhere' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'can_insert_everywhere' => null, + 'can_insert_everywhere' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'can_insert_everywhere' => false, + 'can_insert_everywhere' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -159,7 +168,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'can_insert_everywhere' => 'can_insert_everywhere', + 'can_insert_everywhere' => 'can_insert_everywhere' ]; /** @@ -168,7 +177,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'can_insert_everywhere' => 'setCanInsertEverywhere', + 'can_insert_everywhere' => 'setCanInsertEverywhere' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'can_insert_everywhere' => 'getCanInsertEverywhere', + 'can_insert_everywhere' => 'getCanInsertEverywhere' ]; /** @@ -221,6 +230,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -239,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('can_insert_everywhere', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubOptions { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubOptions { /** @var SubOptions */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubOptions::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -282,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -296,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets can_insert_everywhere * @@ -309,26 +323,27 @@ public function getCanInsertEverywhere() /** * Sets can_insert_everywhere * - * @param bool|null $can_insert_everywhere determines if signers can use \"Insert Everywhere\" when signing a document + * @param bool|null $can_insert_everywhere Determines if signers can use \"Insert Everywhere\" when signing a document. * * @return self */ - public function setCanInsertEverywhere(?bool $can_insert_everywhere) + public function setCanInsertEverywhere($can_insert_everywhere) { if (is_null($can_insert_everywhere)) { - throw new InvalidArgumentException('non-nullable can_insert_everywhere cannot be null'); + throw new \InvalidArgumentException('non-nullable can_insert_everywhere cannot be null'); } $this->container['can_insert_everywhere'] = $can_insert_everywhere; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -337,11 +352,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -352,8 +367,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -366,9 +383,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -376,15 +395,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -410,3 +429,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php b/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php index 2d15bc241..160375e08 100644 --- a/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php +++ b/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubSignatureRequestGroupedSigners Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubSignatureRequestGroupedSigners implements ModelInterface, ArrayAccess, JsonSerializable +class SubSignatureRequestGroupedSigners implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubSignatureRequestGroupedSigners'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'group' => 'string', 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestSigner[]', - 'order' => 'int', + 'order' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'group' => null, 'signers' => null, - 'order' => null, + 'order' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'group' => false, 'signers' => false, - 'order' => true, + 'order' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'group' => 'group', 'signers' => 'signers', - 'order' => 'order', + 'order' => 'order' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'group' => 'setGroup', 'signers' => 'setSigners', - 'order' => 'setOrder', + 'order' => 'setOrder' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'group' => 'getGroup', 'signers' => 'getSigners', - 'order' => 'getOrder', + 'order' => 'getOrder' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('order', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubSignatureRequestGroupedSigners { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubSignatureRequestGroupedSigners { /** @var SubSignatureRequestGroupedSigners */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubSignatureRequestGroupedSigners::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,6 +328,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets group * @@ -330,14 +342,14 @@ public function getGroup() /** * Sets group * - * @param string $group the name of the group + * @param string $group The name of the group. * * @return self */ - public function setGroup(string $group) + public function setGroup($group) { if (is_null($group)) { - throw new InvalidArgumentException('non-nullable group cannot be null'); + throw new \InvalidArgumentException('non-nullable group cannot be null'); } $this->container['group'] = $group; @@ -347,7 +359,7 @@ public function setGroup(string $group) /** * Gets signers * - * @return SubSignatureRequestSigner[] + * @return \Dropbox\Sign\Model\SubSignatureRequestSigner[] */ public function getSigners() { @@ -357,14 +369,14 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestSigner[] $signers Signers belonging to this Group. **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. + * @param \Dropbox\Sign\Model\SubSignatureRequestSigner[] $signers Signers belonging to this Group. **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. * * @return self */ - public function setSigners(array $signers) + public function setSigners($signers) { if (is_null($signers)) { - throw new InvalidArgumentException('non-nullable signers cannot be null'); + throw new \InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -388,14 +400,14 @@ public function getOrder() * * @return self */ - public function setOrder(?int $order) + public function setOrder($order) { if (is_null($order)) { array_push($this->openAPINullablesSetToNull, 'order'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('order', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -404,13 +416,14 @@ public function setOrder(?int $order) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -419,11 +432,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -434,8 +447,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -448,9 +463,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -458,15 +475,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -492,3 +509,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubSignatureRequestSigner.php b/sdks/php/src/Model/SubSignatureRequestSigner.php index 64133e165..94129127a 100644 --- a/sdks/php/src/Model/SubSignatureRequestSigner.php +++ b/sdks/php/src/Model/SubSignatureRequestSigner.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,79 +29,78 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubSignatureRequestSigner Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubSignatureRequestSigner implements ModelInterface, ArrayAccess, JsonSerializable +class SubSignatureRequestSigner implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubSignatureRequestSigner'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', 'email_address' => 'string', 'order' => 'int', 'pin' => 'string', 'sms_phone_number' => 'string', - 'sms_phone_number_type' => 'string', + 'sms_phone_number_type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, 'email_address' => 'email', 'order' => null, 'pin' => null, 'sms_phone_number' => null, - 'sms_phone_number_type' => null, + 'sms_phone_number_type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'name' => false, 'email_address' => false, 'order' => true, 'pin' => false, 'sms_phone_number' => false, - 'sms_phone_number_type' => false, + 'sms_phone_number_type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -124,6 +125,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -133,7 +136,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -143,7 +146,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -152,6 +155,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -160,6 +166,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -178,7 +187,7 @@ public function isNullableSetToNull(string $property): bool 'order' => 'order', 'pin' => 'pin', 'sms_phone_number' => 'sms_phone_number', - 'sms_phone_number_type' => 'sms_phone_number_type', + 'sms_phone_number_type' => 'sms_phone_number_type' ]; /** @@ -192,7 +201,7 @@ public function isNullableSetToNull(string $property): bool 'order' => 'setOrder', 'pin' => 'setPin', 'sms_phone_number' => 'setSmsPhoneNumber', - 'sms_phone_number_type' => 'setSmsPhoneNumberType', + 'sms_phone_number_type' => 'setSmsPhoneNumberType' ]; /** @@ -206,7 +215,7 @@ public function isNullableSetToNull(string $property): bool 'order' => 'getOrder', 'pin' => 'getPin', 'sms_phone_number' => 'getSmsPhoneNumber', - 'sms_phone_number_type' => 'getSmsPhoneNumberType', + 'sms_phone_number_type' => 'getSmsPhoneNumberType' ]; /** @@ -289,33 +298,34 @@ public function __construct(array $data = null) $this->setIfExists('sms_phone_number_type', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubSignatureRequestSigner { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubSignatureRequestSigner { /** @var SubSignatureRequestSigner */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubSignatureRequestSigner::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -371,6 +381,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -384,14 +395,14 @@ public function getName() /** * Sets name * - * @param string $name the name of the signer + * @param string $name The name of the signer. * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -411,14 +422,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address of the signer + * @param string $email_address The email address of the signer. * * @return self */ - public function setEmailAddress(string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -438,18 +449,18 @@ public function getOrder() /** * Sets order * - * @param int|null $order the order the signer is required to sign in + * @param int|null $order The order the signer is required to sign in. * * @return self */ - public function setOrder(?int $order) + public function setOrder($order) { if (is_null($order)) { array_push($this->openAPINullablesSetToNull, 'order'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('order', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -472,20 +483,20 @@ public function getPin() /** * Sets pin * - * @param string|null $pin the 4- to 12-character access code that will secure this signer's signature page + * @param string|null $pin The 4- to 12-character access code that will secure this signer's signature page. * * @return self */ - public function setPin(?string $pin) + public function setPin($pin) { if (is_null($pin)) { - throw new InvalidArgumentException('non-nullable pin cannot be null'); + throw new \InvalidArgumentException('non-nullable pin cannot be null'); } - if (mb_strlen($pin) > 12) { - throw new InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestSigner., must be smaller than or equal to 12.'); + if ((mb_strlen($pin) > 12)) { + throw new \InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestSigner., must be smaller than or equal to 12.'); } - if (mb_strlen($pin) < 4) { - throw new InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestSigner., must be bigger than or equal to 4.'); + if ((mb_strlen($pin) < 4)) { + throw new \InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestSigner., must be bigger than or equal to 4.'); } $this->container['pin'] = $pin; @@ -510,10 +521,10 @@ public function getSmsPhoneNumber() * * @return self */ - public function setSmsPhoneNumber(?string $sms_phone_number) + public function setSmsPhoneNumber($sms_phone_number) { if (is_null($sms_phone_number)) { - throw new InvalidArgumentException('non-nullable sms_phone_number cannot be null'); + throw new \InvalidArgumentException('non-nullable sms_phone_number cannot be null'); } $this->container['sms_phone_number'] = $sms_phone_number; @@ -537,14 +548,14 @@ public function getSmsPhoneNumberType() * * @return self */ - public function setSmsPhoneNumberType(?string $sms_phone_number_type) + public function setSmsPhoneNumberType($sms_phone_number_type) { if (is_null($sms_phone_number_type)) { - throw new InvalidArgumentException('non-nullable sms_phone_number_type cannot be null'); + throw new \InvalidArgumentException('non-nullable sms_phone_number_type cannot be null'); } $allowedValues = $this->getSmsPhoneNumberTypeAllowableValues(); if (!in_array($sms_phone_number_type, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'sms_phone_number_type', must be one of '%s'", $sms_phone_number_type, @@ -556,13 +567,14 @@ public function setSmsPhoneNumberType(?string $sms_phone_number_type) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -571,11 +583,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -586,8 +598,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -600,9 +614,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -610,15 +626,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -644,3 +660,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php b/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php index 15070e31f..c642cd421 100644 --- a/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php +++ b/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,79 +29,78 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubSignatureRequestTemplateSigner Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubSignatureRequestTemplateSigner implements ModelInterface, ArrayAccess, JsonSerializable +class SubSignatureRequestTemplateSigner implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubSignatureRequestTemplateSigner'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'role' => 'string', 'name' => 'string', 'email_address' => 'string', 'pin' => 'string', 'sms_phone_number' => 'string', - 'sms_phone_number_type' => 'string', + 'sms_phone_number_type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'role' => null, 'name' => null, 'email_address' => 'email', 'pin' => null, 'sms_phone_number' => null, - 'sms_phone_number_type' => null, + 'sms_phone_number_type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'role' => false, 'name' => false, 'email_address' => false, 'pin' => false, 'sms_phone_number' => false, - 'sms_phone_number_type' => false, + 'sms_phone_number_type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -124,6 +125,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -133,7 +136,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -143,7 +146,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -152,6 +155,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -160,6 +166,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -178,7 +187,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'email_address', 'pin' => 'pin', 'sms_phone_number' => 'sms_phone_number', - 'sms_phone_number_type' => 'sms_phone_number_type', + 'sms_phone_number_type' => 'sms_phone_number_type' ]; /** @@ -192,7 +201,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'setEmailAddress', 'pin' => 'setPin', 'sms_phone_number' => 'setSmsPhoneNumber', - 'sms_phone_number_type' => 'setSmsPhoneNumberType', + 'sms_phone_number_type' => 'setSmsPhoneNumberType' ]; /** @@ -206,7 +215,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'getEmailAddress', 'pin' => 'getPin', 'sms_phone_number' => 'getSmsPhoneNumber', - 'sms_phone_number_type' => 'getSmsPhoneNumberType', + 'sms_phone_number_type' => 'getSmsPhoneNumberType' ]; /** @@ -289,33 +298,34 @@ public function __construct(array $data = null) $this->setIfExists('sms_phone_number_type', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubSignatureRequestTemplateSigner { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubSignatureRequestTemplateSigner { /** @var SubSignatureRequestTemplateSigner */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubSignatureRequestTemplateSigner::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -374,6 +384,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets role * @@ -391,10 +402,10 @@ public function getRole() * * @return self */ - public function setRole(string $role) + public function setRole($role) { if (is_null($role)) { - throw new InvalidArgumentException('non-nullable role cannot be null'); + throw new \InvalidArgumentException('non-nullable role cannot be null'); } $this->container['role'] = $role; @@ -414,14 +425,14 @@ public function getName() /** * Sets name * - * @param string $name the name of the signer + * @param string $name The name of the signer. * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -441,14 +452,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address of the signer + * @param string $email_address The email address of the signer. * * @return self */ - public function setEmailAddress(string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -468,20 +479,20 @@ public function getPin() /** * Sets pin * - * @param string|null $pin the 4- to 12-character access code that will secure this signer's signature page + * @param string|null $pin The 4- to 12-character access code that will secure this signer's signature page. * * @return self */ - public function setPin(?string $pin) + public function setPin($pin) { if (is_null($pin)) { - throw new InvalidArgumentException('non-nullable pin cannot be null'); + throw new \InvalidArgumentException('non-nullable pin cannot be null'); } - if (mb_strlen($pin) > 12) { - throw new InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestTemplateSigner., must be smaller than or equal to 12.'); + if ((mb_strlen($pin) > 12)) { + throw new \InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestTemplateSigner., must be smaller than or equal to 12.'); } - if (mb_strlen($pin) < 4) { - throw new InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestTemplateSigner., must be bigger than or equal to 4.'); + if ((mb_strlen($pin) < 4)) { + throw new \InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestTemplateSigner., must be bigger than or equal to 4.'); } $this->container['pin'] = $pin; @@ -506,10 +517,10 @@ public function getSmsPhoneNumber() * * @return self */ - public function setSmsPhoneNumber(?string $sms_phone_number) + public function setSmsPhoneNumber($sms_phone_number) { if (is_null($sms_phone_number)) { - throw new InvalidArgumentException('non-nullable sms_phone_number cannot be null'); + throw new \InvalidArgumentException('non-nullable sms_phone_number cannot be null'); } $this->container['sms_phone_number'] = $sms_phone_number; @@ -533,14 +544,14 @@ public function getSmsPhoneNumberType() * * @return self */ - public function setSmsPhoneNumberType(?string $sms_phone_number_type) + public function setSmsPhoneNumberType($sms_phone_number_type) { if (is_null($sms_phone_number_type)) { - throw new InvalidArgumentException('non-nullable sms_phone_number_type cannot be null'); + throw new \InvalidArgumentException('non-nullable sms_phone_number_type cannot be null'); } $allowedValues = $this->getSmsPhoneNumberTypeAllowableValues(); if (!in_array($sms_phone_number_type, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'sms_phone_number_type', must be one of '%s'", $sms_phone_number_type, @@ -552,13 +563,14 @@ public function setSmsPhoneNumberType(?string $sms_phone_number_type) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -567,11 +579,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -582,8 +594,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -596,9 +610,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -606,15 +622,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -640,3 +656,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubSigningOptions.php b/sdks/php/src/Model/SubSigningOptions.php index 8cbaff0f0..24a75fd04 100644 --- a/sdks/php/src/Model/SubSigningOptions.php +++ b/sdks/php/src/Model/SubSigningOptions.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,77 +29,76 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubSigningOptions Class Doc Comment * * @category Class * @description This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubSigningOptions implements ModelInterface, ArrayAccess, JsonSerializable +class SubSigningOptions implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubSigningOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'default_type' => 'string', 'draw' => 'bool', 'phone' => 'bool', 'type' => 'bool', - 'upload' => 'bool', + 'upload' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'default_type' => null, 'draw' => null, 'phone' => null, 'type' => null, - 'upload' => null, + 'upload' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'default_type' => false, 'draw' => false, 'phone' => false, 'type' => false, - 'upload' => false, + 'upload' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -122,6 +123,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -131,7 +134,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +144,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,6 +153,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -158,6 +164,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool 'draw' => 'draw', 'phone' => 'phone', 'type' => 'type', - 'upload' => 'upload', + 'upload' => 'upload' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool 'draw' => 'setDraw', 'phone' => 'setPhone', 'type' => 'setType', - 'upload' => 'setUpload', + 'upload' => 'setUpload' ]; /** @@ -201,7 +210,7 @@ public function isNullableSetToNull(string $property): bool 'draw' => 'getDraw', 'phone' => 'getPhone', 'type' => 'getType', - 'upload' => 'getUpload', + 'upload' => 'getUpload' ]; /** @@ -287,33 +296,34 @@ public function __construct(array $data = null) $this->setIfExists('upload', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubSigningOptions { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubSigningOptions { /** @var SubSigningOptions */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubSigningOptions::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -358,6 +368,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets default_type * @@ -375,14 +386,14 @@ public function getDefaultType() * * @return self */ - public function setDefaultType(string $default_type) + public function setDefaultType($default_type) { if (is_null($default_type)) { - throw new InvalidArgumentException('non-nullable default_type cannot be null'); + throw new \InvalidArgumentException('non-nullable default_type cannot be null'); } $allowedValues = $this->getDefaultTypeAllowableValues(); if (!in_array($default_type, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'default_type', must be one of '%s'", $default_type, @@ -412,10 +423,10 @@ public function getDraw() * * @return self */ - public function setDraw(?bool $draw) + public function setDraw($draw) { if (is_null($draw)) { - throw new InvalidArgumentException('non-nullable draw cannot be null'); + throw new \InvalidArgumentException('non-nullable draw cannot be null'); } $this->container['draw'] = $draw; @@ -439,10 +450,10 @@ public function getPhone() * * @return self */ - public function setPhone(?bool $phone) + public function setPhone($phone) { if (is_null($phone)) { - throw new InvalidArgumentException('non-nullable phone cannot be null'); + throw new \InvalidArgumentException('non-nullable phone cannot be null'); } $this->container['phone'] = $phone; @@ -466,10 +477,10 @@ public function getType() * * @return self */ - public function setType(?bool $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -493,22 +504,23 @@ public function getUpload() * * @return self */ - public function setUpload(?bool $upload) + public function setUpload($upload) { if (is_null($upload)) { - throw new InvalidArgumentException('non-nullable upload cannot be null'); + throw new \InvalidArgumentException('non-nullable upload cannot be null'); } $this->container['upload'] = $upload; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -517,11 +529,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -532,8 +544,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -546,9 +560,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -556,15 +572,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -590,3 +606,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubTeamResponse.php b/sdks/php/src/Model/SubTeamResponse.php index 60ecc442a..30f1dbae8 100644 --- a/sdks/php/src/Model/SubTeamResponse.php +++ b/sdks/php/src/Model/SubTeamResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubTeamResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubTeamResponse implements ModelInterface, ArrayAccess, JsonSerializable +class SubTeamResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubTeamResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team_id' => 'string', - 'name' => 'string', + 'name' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team_id' => null, - 'name' => null, + 'name' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'team_id' => false, - 'name' => false, + 'name' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'team_id' => 'team_id', - 'name' => 'name', + 'name' => 'name' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'team_id' => 'setTeamId', - 'name' => 'setName', + 'name' => 'setName' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'team_id' => 'getTeamId', - 'name' => 'getName', + 'name' => 'getName' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubTeamResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubTeamResponse { /** @var SubTeamResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubTeamResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -288,7 +299,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -302,6 +315,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets team_id * @@ -319,10 +333,10 @@ public function getTeamId() * * @return self */ - public function setTeamId(?string $team_id) + public function setTeamId($team_id) { if (is_null($team_id)) { - throw new InvalidArgumentException('non-nullable team_id cannot be null'); + throw new \InvalidArgumentException('non-nullable team_id cannot be null'); } $this->container['team_id'] = $team_id; @@ -346,22 +360,23 @@ public function getName() * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -370,11 +385,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -385,8 +400,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -399,9 +416,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -409,15 +428,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -443,3 +462,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubTemplateRole.php b/sdks/php/src/Model/SubTemplateRole.php index 2678da93a..53d37b44d 100644 --- a/sdks/php/src/Model/SubTemplateRole.php +++ b/sdks/php/src/Model/SubTemplateRole.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubTemplateRole Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubTemplateRole implements ModelInterface, ArrayAccess, JsonSerializable +class SubTemplateRole implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubTemplateRole'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', - 'order' => 'int', + 'order' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, - 'order' => null, + 'order' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'name' => false, - 'order' => true, + 'order' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'order' => 'order', + 'order' => 'order' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'order' => 'setOrder', + 'order' => 'setOrder' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'order' => 'getOrder', + 'order' => 'getOrder' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('order', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubTemplateRole { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubTemplateRole { /** @var SubTemplateRole */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubTemplateRole::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -288,7 +299,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -302,6 +315,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -315,14 +329,14 @@ public function getName() /** * Sets name * - * @param string|null $name the role name of the signer that will be displayed when the template is used to create a signature request + * @param string|null $name The role name of the signer that will be displayed when the template is used to create a signature request. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -342,18 +356,18 @@ public function getOrder() /** * Sets order * - * @param int|null $order the order in which this signer role is required to sign + * @param int|null $order The order in which this signer role is required to sign. * * @return self */ - public function setOrder(?int $order) + public function setOrder($order) { if (is_null($order)) { array_push($this->openAPINullablesSetToNull, 'order'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('order', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -362,13 +376,14 @@ public function setOrder(?int $order) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -377,11 +392,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -392,8 +407,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -406,9 +423,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -416,15 +435,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -450,3 +469,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubUnclaimedDraftSigner.php b/sdks/php/src/Model/SubUnclaimedDraftSigner.php index acc466356..aa2a1995a 100644 --- a/sdks/php/src/Model/SubUnclaimedDraftSigner.php +++ b/sdks/php/src/Model/SubUnclaimedDraftSigner.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubUnclaimedDraftSigner Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubUnclaimedDraftSigner implements ModelInterface, ArrayAccess, JsonSerializable +class SubUnclaimedDraftSigner implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubUnclaimedDraftSigner'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'email_address' => 'string', 'name' => 'string', - 'order' => 'int', + 'order' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'email_address' => 'email', 'name' => null, - 'order' => null, + 'order' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'email_address' => false, 'name' => false, - 'order' => true, + 'order' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'email_address' => 'email_address', 'name' => 'name', - 'order' => 'order', + 'order' => 'order' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'email_address' => 'setEmailAddress', 'name' => 'setName', - 'order' => 'setOrder', + 'order' => 'setOrder' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'email_address' => 'getEmailAddress', 'name' => 'getName', - 'order' => 'getOrder', + 'order' => 'getOrder' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('order', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubUnclaimedDraftSigner { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubUnclaimedDraftSigner { /** @var SubUnclaimedDraftSigner */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubUnclaimedDraftSigner::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,6 +328,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets email_address * @@ -330,14 +342,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address of the signer + * @param string $email_address The email address of the signer. * * @return self */ - public function setEmailAddress(string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -357,14 +369,14 @@ public function getName() /** * Sets name * - * @param string $name the name of the signer + * @param string $name The name of the signer. * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -384,18 +396,18 @@ public function getOrder() /** * Sets order * - * @param int|null $order the order the signer is required to sign in + * @param int|null $order The order the signer is required to sign in. * * @return self */ - public function setOrder(?int $order) + public function setOrder($order) { if (is_null($order)) { array_push($this->openAPINullablesSetToNull, 'order'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('order', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -404,13 +416,14 @@ public function setOrder(?int $order) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -419,11 +432,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -434,8 +447,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -448,9 +463,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -458,15 +475,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -492,3 +509,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php b/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php index 9daffb1e4..ee8818c41 100644 --- a/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php +++ b/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubUnclaimedDraftTemplateSigner Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubUnclaimedDraftTemplateSigner implements ModelInterface, ArrayAccess, JsonSerializable +class SubUnclaimedDraftTemplateSigner implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubUnclaimedDraftTemplateSigner'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'role' => 'string', 'name' => 'string', - 'email_address' => 'string', + 'email_address' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'role' => null, 'name' => null, - 'email_address' => 'email', + 'email_address' => 'email' ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'role' => false, 'name' => false, - 'email_address' => false, + 'email_address' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'role' => 'role', 'name' => 'name', - 'email_address' => 'email_address', + 'email_address' => 'email_address' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'role' => 'setRole', 'name' => 'setName', - 'email_address' => 'setEmailAddress', + 'email_address' => 'setEmailAddress' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'role' => 'getRole', 'name' => 'getName', - 'email_address' => 'getEmailAddress', + 'email_address' => 'getEmailAddress' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubUnclaimedDraftTemplateSigner { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubUnclaimedDraftTemplateSigner { /** @var SubUnclaimedDraftTemplateSigner */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubUnclaimedDraftTemplateSigner::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -320,6 +331,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets role * @@ -333,14 +345,14 @@ public function getRole() /** * Sets role * - * @param string $role must match an existing role in chosen Template(s) + * @param string $role Must match an existing role in chosen Template(s). * * @return self */ - public function setRole(string $role) + public function setRole($role) { if (is_null($role)) { - throw new InvalidArgumentException('non-nullable role cannot be null'); + throw new \InvalidArgumentException('non-nullable role cannot be null'); } $this->container['role'] = $role; @@ -360,14 +372,14 @@ public function getName() /** * Sets name * - * @param string $name the name of the signer filling the role of `role` + * @param string $name The name of the signer filling the role of `role`. * * @return self */ - public function setName(string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -387,26 +399,27 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address of the signer filling the role of `role` + * @param string $email_address The email address of the signer filling the role of `role`. * * @return self */ - public function setEmailAddress(string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -415,11 +428,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -430,8 +443,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -444,9 +459,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -454,15 +471,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -488,3 +505,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/SubWhiteLabelingOptions.php b/sdks/php/src/Model/SubWhiteLabelingOptions.php index 0abcbd111..d088f98cd 100644 --- a/sdks/php/src/Model/SubWhiteLabelingOptions.php +++ b/sdks/php/src/Model/SubWhiteLabelingOptions.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * SubWhiteLabelingOptions Class Doc Comment * * @category Class * @description An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class SubWhiteLabelingOptions implements ModelInterface, ArrayAccess, JsonSerializable +class SubWhiteLabelingOptions implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubWhiteLabelingOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'header_background_color' => 'string', 'legal_version' => 'string', @@ -72,16 +73,16 @@ class SubWhiteLabelingOptions implements ModelInterface, ArrayAccess, JsonSerial 'secondary_button_text_color_hover' => 'string', 'text_color1' => 'string', 'text_color2' => 'string', - 'reset_to_default' => 'bool', + 'reset_to_default' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'header_background_color' => null, 'legal_version' => null, @@ -97,14 +98,14 @@ class SubWhiteLabelingOptions implements ModelInterface, ArrayAccess, JsonSerial 'secondary_button_text_color_hover' => null, 'text_color1' => null, 'text_color2' => null, - 'reset_to_default' => null, + 'reset_to_default' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'header_background_color' => false, 'legal_version' => false, @@ -120,14 +121,14 @@ class SubWhiteLabelingOptions implements ModelInterface, ArrayAccess, JsonSerial 'secondary_button_text_color_hover' => false, 'text_color1' => false, 'text_color2' => false, - 'reset_to_default' => false, + 'reset_to_default' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -152,6 +153,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -161,7 +164,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -171,7 +174,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -180,6 +183,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -188,6 +194,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -215,7 +224,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color_hover' => 'secondary_button_text_color_hover', 'text_color1' => 'text_color1', 'text_color2' => 'text_color2', - 'reset_to_default' => 'reset_to_default', + 'reset_to_default' => 'reset_to_default' ]; /** @@ -238,7 +247,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color_hover' => 'setSecondaryButtonTextColorHover', 'text_color1' => 'setTextColor1', 'text_color2' => 'setTextColor2', - 'reset_to_default' => 'setResetToDefault', + 'reset_to_default' => 'setResetToDefault' ]; /** @@ -261,7 +270,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color_hover' => 'getSecondaryButtonTextColorHover', 'text_color1' => 'getTextColor1', 'text_color2' => 'getTextColor2', - 'reset_to_default' => 'getResetToDefault', + 'reset_to_default' => 'getResetToDefault' ]; /** @@ -353,33 +362,34 @@ public function __construct(array $data = null) $this->setIfExists('reset_to_default', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): SubWhiteLabelingOptions { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): SubWhiteLabelingOptions { /** @var SubWhiteLabelingOptions */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, SubWhiteLabelingOptions::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -421,6 +431,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets header_background_color * @@ -438,10 +449,10 @@ public function getHeaderBackgroundColor() * * @return self */ - public function setHeaderBackgroundColor(?string $header_background_color) + public function setHeaderBackgroundColor($header_background_color) { if (is_null($header_background_color)) { - throw new InvalidArgumentException('non-nullable header_background_color cannot be null'); + throw new \InvalidArgumentException('non-nullable header_background_color cannot be null'); } $this->container['header_background_color'] = $header_background_color; @@ -465,14 +476,14 @@ public function getLegalVersion() * * @return self */ - public function setLegalVersion(?string $legal_version) + public function setLegalVersion($legal_version) { if (is_null($legal_version)) { - throw new InvalidArgumentException('non-nullable legal_version cannot be null'); + throw new \InvalidArgumentException('non-nullable legal_version cannot be null'); } $allowedValues = $this->getLegalVersionAllowableValues(); if (!in_array($legal_version, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'legal_version', must be one of '%s'", $legal_version, @@ -502,10 +513,10 @@ public function getLinkColor() * * @return self */ - public function setLinkColor(?string $link_color) + public function setLinkColor($link_color) { if (is_null($link_color)) { - throw new InvalidArgumentException('non-nullable link_color cannot be null'); + throw new \InvalidArgumentException('non-nullable link_color cannot be null'); } $this->container['link_color'] = $link_color; @@ -529,10 +540,10 @@ public function getPageBackgroundColor() * * @return self */ - public function setPageBackgroundColor(?string $page_background_color) + public function setPageBackgroundColor($page_background_color) { if (is_null($page_background_color)) { - throw new InvalidArgumentException('non-nullable page_background_color cannot be null'); + throw new \InvalidArgumentException('non-nullable page_background_color cannot be null'); } $this->container['page_background_color'] = $page_background_color; @@ -556,10 +567,10 @@ public function getPrimaryButtonColor() * * @return self */ - public function setPrimaryButtonColor(?string $primary_button_color) + public function setPrimaryButtonColor($primary_button_color) { if (is_null($primary_button_color)) { - throw new InvalidArgumentException('non-nullable primary_button_color cannot be null'); + throw new \InvalidArgumentException('non-nullable primary_button_color cannot be null'); } $this->container['primary_button_color'] = $primary_button_color; @@ -583,10 +594,10 @@ public function getPrimaryButtonColorHover() * * @return self */ - public function setPrimaryButtonColorHover(?string $primary_button_color_hover) + public function setPrimaryButtonColorHover($primary_button_color_hover) { if (is_null($primary_button_color_hover)) { - throw new InvalidArgumentException('non-nullable primary_button_color_hover cannot be null'); + throw new \InvalidArgumentException('non-nullable primary_button_color_hover cannot be null'); } $this->container['primary_button_color_hover'] = $primary_button_color_hover; @@ -610,10 +621,10 @@ public function getPrimaryButtonTextColor() * * @return self */ - public function setPrimaryButtonTextColor(?string $primary_button_text_color) + public function setPrimaryButtonTextColor($primary_button_text_color) { if (is_null($primary_button_text_color)) { - throw new InvalidArgumentException('non-nullable primary_button_text_color cannot be null'); + throw new \InvalidArgumentException('non-nullable primary_button_text_color cannot be null'); } $this->container['primary_button_text_color'] = $primary_button_text_color; @@ -637,10 +648,10 @@ public function getPrimaryButtonTextColorHover() * * @return self */ - public function setPrimaryButtonTextColorHover(?string $primary_button_text_color_hover) + public function setPrimaryButtonTextColorHover($primary_button_text_color_hover) { if (is_null($primary_button_text_color_hover)) { - throw new InvalidArgumentException('non-nullable primary_button_text_color_hover cannot be null'); + throw new \InvalidArgumentException('non-nullable primary_button_text_color_hover cannot be null'); } $this->container['primary_button_text_color_hover'] = $primary_button_text_color_hover; @@ -664,10 +675,10 @@ public function getSecondaryButtonColor() * * @return self */ - public function setSecondaryButtonColor(?string $secondary_button_color) + public function setSecondaryButtonColor($secondary_button_color) { if (is_null($secondary_button_color)) { - throw new InvalidArgumentException('non-nullable secondary_button_color cannot be null'); + throw new \InvalidArgumentException('non-nullable secondary_button_color cannot be null'); } $this->container['secondary_button_color'] = $secondary_button_color; @@ -691,10 +702,10 @@ public function getSecondaryButtonColorHover() * * @return self */ - public function setSecondaryButtonColorHover(?string $secondary_button_color_hover) + public function setSecondaryButtonColorHover($secondary_button_color_hover) { if (is_null($secondary_button_color_hover)) { - throw new InvalidArgumentException('non-nullable secondary_button_color_hover cannot be null'); + throw new \InvalidArgumentException('non-nullable secondary_button_color_hover cannot be null'); } $this->container['secondary_button_color_hover'] = $secondary_button_color_hover; @@ -718,10 +729,10 @@ public function getSecondaryButtonTextColor() * * @return self */ - public function setSecondaryButtonTextColor(?string $secondary_button_text_color) + public function setSecondaryButtonTextColor($secondary_button_text_color) { if (is_null($secondary_button_text_color)) { - throw new InvalidArgumentException('non-nullable secondary_button_text_color cannot be null'); + throw new \InvalidArgumentException('non-nullable secondary_button_text_color cannot be null'); } $this->container['secondary_button_text_color'] = $secondary_button_text_color; @@ -745,10 +756,10 @@ public function getSecondaryButtonTextColorHover() * * @return self */ - public function setSecondaryButtonTextColorHover(?string $secondary_button_text_color_hover) + public function setSecondaryButtonTextColorHover($secondary_button_text_color_hover) { if (is_null($secondary_button_text_color_hover)) { - throw new InvalidArgumentException('non-nullable secondary_button_text_color_hover cannot be null'); + throw new \InvalidArgumentException('non-nullable secondary_button_text_color_hover cannot be null'); } $this->container['secondary_button_text_color_hover'] = $secondary_button_text_color_hover; @@ -772,10 +783,10 @@ public function getTextColor1() * * @return self */ - public function setTextColor1(?string $text_color1) + public function setTextColor1($text_color1) { if (is_null($text_color1)) { - throw new InvalidArgumentException('non-nullable text_color1 cannot be null'); + throw new \InvalidArgumentException('non-nullable text_color1 cannot be null'); } $this->container['text_color1'] = $text_color1; @@ -799,10 +810,10 @@ public function getTextColor2() * * @return self */ - public function setTextColor2(?string $text_color2) + public function setTextColor2($text_color2) { if (is_null($text_color2)) { - throw new InvalidArgumentException('non-nullable text_color2 cannot be null'); + throw new \InvalidArgumentException('non-nullable text_color2 cannot be null'); } $this->container['text_color2'] = $text_color2; @@ -826,22 +837,23 @@ public function getResetToDefault() * * @return self */ - public function setResetToDefault(?bool $reset_to_default) + public function setResetToDefault($reset_to_default) { if (is_null($reset_to_default)) { - throw new InvalidArgumentException('non-nullable reset_to_default cannot be null'); + throw new \InvalidArgumentException('non-nullable reset_to_default cannot be null'); } $this->container['reset_to_default'] = $reset_to_default; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -850,11 +862,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -865,8 +877,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -879,9 +893,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -889,15 +905,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -923,3 +939,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamAddMemberRequest.php b/sdks/php/src/Model/TeamAddMemberRequest.php index e38abb02f..f3b1bbe91 100644 --- a/sdks/php/src/Model/TeamAddMemberRequest.php +++ b/sdks/php/src/Model/TeamAddMemberRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamAddMemberRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamAddMemberRequest implements ModelInterface, ArrayAccess, JsonSerializable +class TeamAddMemberRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamAddMemberRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', - 'role' => 'string', + 'role' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => 'email', - 'role' => null, + 'role' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, - 'role' => false, + 'role' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'account_id' => 'account_id', 'email_address' => 'email_address', - 'role' => 'role', + 'role' => 'role' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'account_id' => 'setAccountId', 'email_address' => 'setEmailAddress', - 'role' => 'setRole', + 'role' => 'setRole' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'account_id' => 'getAccountId', 'email_address' => 'getEmailAddress', - 'role' => 'getRole', + 'role' => 'getRole' ]; /** @@ -272,33 +281,34 @@ public function __construct(array $data = null) $this->setIfExists('role', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamAddMemberRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamAddMemberRequest { /** @var TeamAddMemberRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamAddMemberRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -340,6 +350,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account_id * @@ -357,10 +368,10 @@ public function getAccountId() * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -384,10 +395,10 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -411,14 +422,14 @@ public function getRole() * * @return self */ - public function setRole(?string $role) + public function setRole($role) { if (is_null($role)) { - throw new InvalidArgumentException('non-nullable role cannot be null'); + throw new \InvalidArgumentException('non-nullable role cannot be null'); } $allowedValues = $this->getRoleAllowableValues(); if (!in_array($role, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'role', must be one of '%s'", $role, @@ -430,13 +441,14 @@ public function setRole(?string $role) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -445,11 +457,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -460,8 +472,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -474,9 +488,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -484,15 +500,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -518,3 +534,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamCreateRequest.php b/sdks/php/src/Model/TeamCreateRequest.php index 6ba37cc71..8dc152f06 100644 --- a/sdks/php/src/Model/TeamCreateRequest.php +++ b/sdks/php/src/Model/TeamCreateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamCreateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class TeamCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'name' => 'string', + 'name' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'name' => null, + 'name' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'name' => false, + 'name' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'name' => 'name', + 'name' => 'name' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'name' => 'setName', + 'name' => 'setName' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'name' => 'getName', + 'name' => 'getName' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], 'Untitled Team'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamCreateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamCreateRequest { /** @var TeamCreateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamCreateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +292,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -295,6 +308,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -308,26 +322,27 @@ public function getName() /** * Sets name * - * @param string|null $name the name of your Team + * @param string|null $name The name of your Team. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -336,11 +351,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -351,8 +366,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -365,9 +382,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -375,15 +394,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -409,3 +428,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamGetInfoResponse.php b/sdks/php/src/Model/TeamGetInfoResponse.php index cfac0efbb..a2f67e209 100644 --- a/sdks/php/src/Model/TeamGetInfoResponse.php +++ b/sdks/php/src/Model/TeamGetInfoResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamGetInfoResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamGetInfoResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TeamGetInfoResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamGetInfoResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team' => '\Dropbox\Sign\Model\TeamInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'team' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'team' => 'team', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'team' => 'setTeam', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'team' => 'getTeam', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamGetInfoResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamGetInfoResponse { /** @var TeamGetInfoResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamGetInfoResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets team * - * @return TeamInfoResponse + * @return \Dropbox\Sign\Model\TeamInfoResponse */ public function getTeam() { @@ -320,14 +332,14 @@ public function getTeam() /** * Sets team * - * @param TeamInfoResponse $team team + * @param \Dropbox\Sign\Model\TeamInfoResponse $team team * * @return self */ - public function setTeam(TeamInfoResponse $team) + public function setTeam($team) { if (is_null($team)) { - throw new InvalidArgumentException('non-nullable team cannot be null'); + throw new \InvalidArgumentException('non-nullable team cannot be null'); } $this->container['team'] = $team; @@ -337,7 +349,7 @@ public function setTeam(TeamInfoResponse $team) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamGetResponse.php b/sdks/php/src/Model/TeamGetResponse.php index 6d23ddc3b..bc857c1d2 100644 --- a/sdks/php/src/Model/TeamGetResponse.php +++ b/sdks/php/src/Model/TeamGetResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamGetResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamGetResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TeamGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team' => '\Dropbox\Sign\Model\TeamResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'team' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'team' => 'team', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'team' => 'setTeam', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'team' => 'getTeam', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamGetResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamGetResponse { /** @var TeamGetResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamGetResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets team * - * @return TeamResponse + * @return \Dropbox\Sign\Model\TeamResponse */ public function getTeam() { @@ -320,14 +332,14 @@ public function getTeam() /** * Sets team * - * @param TeamResponse $team team + * @param \Dropbox\Sign\Model\TeamResponse $team team * * @return self */ - public function setTeam(TeamResponse $team) + public function setTeam($team) { if (is_null($team)) { - throw new InvalidArgumentException('non-nullable team cannot be null'); + throw new \InvalidArgumentException('non-nullable team cannot be null'); } $this->container['team'] = $team; @@ -337,7 +349,7 @@ public function setTeam(TeamResponse $team) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamInfoResponse.php b/sdks/php/src/Model/TeamInfoResponse.php index 3d5ad124a..883e1467e 100644 --- a/sdks/php/src/Model/TeamInfoResponse.php +++ b/sdks/php/src/Model/TeamInfoResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,76 +29,75 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamInfoResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamInfoResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TeamInfoResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamInfoResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team_id' => 'string', 'team_parent' => '\Dropbox\Sign\Model\TeamParentResponse', 'name' => 'string', 'num_members' => 'int', - 'num_sub_teams' => 'int', + 'num_sub_teams' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team_id' => null, 'team_parent' => null, 'name' => null, 'num_members' => null, - 'num_sub_teams' => null, + 'num_sub_teams' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'team_id' => false, 'team_parent' => true, 'name' => false, 'num_members' => false, - 'num_sub_teams' => false, + 'num_sub_teams' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -121,6 +122,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -130,7 +133,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +143,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,6 +152,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -157,6 +163,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -174,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'team_parent' => 'team_parent', 'name' => 'name', 'num_members' => 'num_members', - 'num_sub_teams' => 'num_sub_teams', + 'num_sub_teams' => 'num_sub_teams' ]; /** @@ -187,7 +196,7 @@ public function isNullableSetToNull(string $property): bool 'team_parent' => 'setTeamParent', 'name' => 'setName', 'num_members' => 'setNumMembers', - 'num_sub_teams' => 'setNumSubTeams', + 'num_sub_teams' => 'setNumSubTeams' ]; /** @@ -200,7 +209,7 @@ public function isNullableSetToNull(string $property): bool 'team_parent' => 'getTeamParent', 'name' => 'getName', 'num_members' => 'getNumMembers', - 'num_sub_teams' => 'getNumSubTeams', + 'num_sub_teams' => 'getNumSubTeams' ]; /** @@ -244,6 +253,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -266,33 +276,34 @@ public function __construct(array $data = null) $this->setIfExists('num_sub_teams', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamInfoResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamInfoResponse { /** @var TeamInfoResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamInfoResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -309,7 +320,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -323,6 +336,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets team_id * @@ -340,10 +354,10 @@ public function getTeamId() * * @return self */ - public function setTeamId(?string $team_id) + public function setTeamId($team_id) { if (is_null($team_id)) { - throw new InvalidArgumentException('non-nullable team_id cannot be null'); + throw new \InvalidArgumentException('non-nullable team_id cannot be null'); } $this->container['team_id'] = $team_id; @@ -353,7 +367,7 @@ public function setTeamId(?string $team_id) /** * Gets team_parent * - * @return TeamParentResponse|null + * @return \Dropbox\Sign\Model\TeamParentResponse|null */ public function getTeamParent() { @@ -363,18 +377,18 @@ public function getTeamParent() /** * Sets team_parent * - * @param TeamParentResponse|null $team_parent team_parent + * @param \Dropbox\Sign\Model\TeamParentResponse|null $team_parent team_parent * * @return self */ - public function setTeamParent(?TeamParentResponse $team_parent) + public function setTeamParent($team_parent) { if (is_null($team_parent)) { array_push($this->openAPINullablesSetToNull, 'team_parent'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('team_parent', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -401,10 +415,10 @@ public function getName() * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -428,10 +442,10 @@ public function getNumMembers() * * @return self */ - public function setNumMembers(?int $num_members) + public function setNumMembers($num_members) { if (is_null($num_members)) { - throw new InvalidArgumentException('non-nullable num_members cannot be null'); + throw new \InvalidArgumentException('non-nullable num_members cannot be null'); } $this->container['num_members'] = $num_members; @@ -455,22 +469,23 @@ public function getNumSubTeams() * * @return self */ - public function setNumSubTeams(?int $num_sub_teams) + public function setNumSubTeams($num_sub_teams) { if (is_null($num_sub_teams)) { - throw new InvalidArgumentException('non-nullable num_sub_teams cannot be null'); + throw new \InvalidArgumentException('non-nullable num_sub_teams cannot be null'); } $this->container['num_sub_teams'] = $num_sub_teams; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -479,11 +494,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -494,8 +509,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -508,9 +525,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -518,15 +537,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -552,3 +571,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamInviteResponse.php b/sdks/php/src/Model/TeamInviteResponse.php index d37dae050..09f76a85b 100644 --- a/sdks/php/src/Model/TeamInviteResponse.php +++ b/sdks/php/src/Model/TeamInviteResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,79 +29,78 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamInviteResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamInviteResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TeamInviteResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamInviteResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'email_address' => 'string', 'team_id' => 'string', 'role' => 'string', 'sent_at' => 'int', 'redeemed_at' => 'int', - 'expires_at' => 'int', + 'expires_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'email_address' => null, 'team_id' => null, 'role' => null, 'sent_at' => null, 'redeemed_at' => null, - 'expires_at' => null, + 'expires_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'email_address' => false, 'team_id' => false, 'role' => false, 'sent_at' => false, 'redeemed_at' => false, - 'expires_at' => false, + 'expires_at' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -124,6 +125,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -133,7 +136,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -143,7 +146,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -152,6 +155,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -160,6 +166,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -178,7 +187,7 @@ public function isNullableSetToNull(string $property): bool 'role' => 'role', 'sent_at' => 'sent_at', 'redeemed_at' => 'redeemed_at', - 'expires_at' => 'expires_at', + 'expires_at' => 'expires_at' ]; /** @@ -192,7 +201,7 @@ public function isNullableSetToNull(string $property): bool 'role' => 'setRole', 'sent_at' => 'setSentAt', 'redeemed_at' => 'setRedeemedAt', - 'expires_at' => 'setExpiresAt', + 'expires_at' => 'setExpiresAt' ]; /** @@ -206,7 +215,7 @@ public function isNullableSetToNull(string $property): bool 'role' => 'getRole', 'sent_at' => 'getSentAt', 'redeemed_at' => 'getRedeemedAt', - 'expires_at' => 'getExpiresAt', + 'expires_at' => 'getExpiresAt' ]; /** @@ -250,6 +259,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -273,33 +283,34 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamInviteResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamInviteResponse { /** @var TeamInviteResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamInviteResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -316,7 +327,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -330,6 +343,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets email_address * @@ -343,14 +357,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address email address of the user invited to this team + * @param string|null $email_address Email address of the user invited to this team. * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -370,14 +384,14 @@ public function getTeamId() /** * Sets team_id * - * @param string|null $team_id id of the team + * @param string|null $team_id Id of the team. * * @return self */ - public function setTeamId(?string $team_id) + public function setTeamId($team_id) { if (is_null($team_id)) { - throw new InvalidArgumentException('non-nullable team_id cannot be null'); + throw new \InvalidArgumentException('non-nullable team_id cannot be null'); } $this->container['team_id'] = $team_id; @@ -397,14 +411,14 @@ public function getRole() /** * Sets role * - * @param string|null $role role of the user invited to this team + * @param string|null $role Role of the user invited to this team. * * @return self */ - public function setRole(?string $role) + public function setRole($role) { if (is_null($role)) { - throw new InvalidArgumentException('non-nullable role cannot be null'); + throw new \InvalidArgumentException('non-nullable role cannot be null'); } $this->container['role'] = $role; @@ -424,14 +438,14 @@ public function getSentAt() /** * Sets sent_at * - * @param int|null $sent_at timestamp when the invitation was sent + * @param int|null $sent_at Timestamp when the invitation was sent. * * @return self */ - public function setSentAt(?int $sent_at) + public function setSentAt($sent_at) { if (is_null($sent_at)) { - throw new InvalidArgumentException('non-nullable sent_at cannot be null'); + throw new \InvalidArgumentException('non-nullable sent_at cannot be null'); } $this->container['sent_at'] = $sent_at; @@ -451,14 +465,14 @@ public function getRedeemedAt() /** * Sets redeemed_at * - * @param int|null $redeemed_at timestamp when the invitation was redeemed + * @param int|null $redeemed_at Timestamp when the invitation was redeemed. * * @return self */ - public function setRedeemedAt(?int $redeemed_at) + public function setRedeemedAt($redeemed_at) { if (is_null($redeemed_at)) { - throw new InvalidArgumentException('non-nullable redeemed_at cannot be null'); + throw new \InvalidArgumentException('non-nullable redeemed_at cannot be null'); } $this->container['redeemed_at'] = $redeemed_at; @@ -478,26 +492,27 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at timestamp when the invitation is expiring + * @param int|null $expires_at Timestamp when the invitation is expiring. * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { - throw new InvalidArgumentException('non-nullable expires_at cannot be null'); + throw new \InvalidArgumentException('non-nullable expires_at cannot be null'); } $this->container['expires_at'] = $expires_at; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -506,11 +521,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -521,8 +536,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -535,9 +552,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -545,15 +564,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -579,3 +598,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamInvitesResponse.php b/sdks/php/src/Model/TeamInvitesResponse.php index 31b58b939..6734607b0 100644 --- a/sdks/php/src/Model/TeamInvitesResponse.php +++ b/sdks/php/src/Model/TeamInvitesResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamInvitesResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamInvitesResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TeamInvitesResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamInvitesResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team_invites' => '\Dropbox\Sign\Model\TeamInviteResponse[]', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team_invites' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'team_invites' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'team_invites' => 'team_invites', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'team_invites' => 'setTeamInvites', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'team_invites' => 'getTeamInvites', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamInvitesResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamInvitesResponse { /** @var TeamInvitesResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamInvitesResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets team_invites * - * @return TeamInviteResponse[] + * @return \Dropbox\Sign\Model\TeamInviteResponse[] */ public function getTeamInvites() { @@ -320,14 +332,14 @@ public function getTeamInvites() /** * Sets team_invites * - * @param TeamInviteResponse[] $team_invites contains a list of team invites and their roles + * @param \Dropbox\Sign\Model\TeamInviteResponse[] $team_invites Contains a list of team invites and their roles. * * @return self */ - public function setTeamInvites(array $team_invites) + public function setTeamInvites($team_invites) { if (is_null($team_invites)) { - throw new InvalidArgumentException('non-nullable team_invites cannot be null'); + throw new \InvalidArgumentException('non-nullable team_invites cannot be null'); } $this->container['team_invites'] = $team_invites; @@ -337,7 +349,7 @@ public function setTeamInvites(array $team_invites) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings warnings * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamMemberResponse.php b/sdks/php/src/Model/TeamMemberResponse.php index ee61fbdd3..149b4db2b 100644 --- a/sdks/php/src/Model/TeamMemberResponse.php +++ b/sdks/php/src/Model/TeamMemberResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamMemberResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamMemberResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TeamMemberResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamMemberResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', - 'role' => 'string', + 'role' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => null, - 'role' => null, + 'role' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, - 'role' => false, + 'role' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'account_id' => 'account_id', 'email_address' => 'email_address', - 'role' => 'role', + 'role' => 'role' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'account_id' => 'setAccountId', 'email_address' => 'setEmailAddress', - 'role' => 'setRole', + 'role' => 'setRole' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'account_id' => 'getAccountId', 'email_address' => 'getEmailAddress', - 'role' => 'getRole', + 'role' => 'getRole' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('role', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamMemberResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamMemberResponse { /** @var TeamMemberResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamMemberResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -295,7 +306,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -309,6 +322,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account_id * @@ -322,14 +336,14 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id account id of the team member + * @param string|null $account_id Account id of the team member. * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -349,14 +363,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address email address of the team member + * @param string|null $email_address Email address of the team member. * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -376,26 +390,27 @@ public function getRole() /** * Sets role * - * @param string|null $role the specific role a member has on the team + * @param string|null $role The specific role a member has on the team. * * @return self */ - public function setRole(?string $role) + public function setRole($role) { if (is_null($role)) { - throw new InvalidArgumentException('non-nullable role cannot be null'); + throw new \InvalidArgumentException('non-nullable role cannot be null'); } $this->container['role'] = $role; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -404,11 +419,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -419,8 +434,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -433,9 +450,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -443,15 +462,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -477,3 +496,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamMembersResponse.php b/sdks/php/src/Model/TeamMembersResponse.php index 681ad9af1..b71d18b88 100644 --- a/sdks/php/src/Model/TeamMembersResponse.php +++ b/sdks/php/src/Model/TeamMembersResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamMembersResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamMembersResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TeamMembersResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamMembersResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team_members' => '\Dropbox\Sign\Model\TeamMemberResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team_members' => null, 'list_info' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'team_members' => false, 'list_info' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'team_members' => 'team_members', 'list_info' => 'list_info', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'team_members' => 'setTeamMembers', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'team_members' => 'getTeamMembers', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamMembersResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamMembersResponse { /** @var TeamMembersResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamMembersResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,10 +328,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets team_members * - * @return TeamMemberResponse[] + * @return \Dropbox\Sign\Model\TeamMemberResponse[] */ public function getTeamMembers() { @@ -330,14 +342,14 @@ public function getTeamMembers() /** * Sets team_members * - * @param TeamMemberResponse[] $team_members contains a list of team members and their roles for a specific team + * @param \Dropbox\Sign\Model\TeamMemberResponse[] $team_members Contains a list of team members and their roles for a specific team. * * @return self */ - public function setTeamMembers(array $team_members) + public function setTeamMembers($team_members) { if (is_null($team_members)) { - throw new InvalidArgumentException('non-nullable team_members cannot be null'); + throw new \InvalidArgumentException('non-nullable team_members cannot be null'); } $this->container['team_members'] = $team_members; @@ -347,7 +359,7 @@ public function setTeamMembers(array $team_members) /** * Gets list_info * - * @return ListInfoResponse + * @return \Dropbox\Sign\Model\ListInfoResponse */ public function getListInfo() { @@ -357,14 +369,14 @@ public function getListInfo() /** * Sets list_info * - * @param ListInfoResponse $list_info list_info + * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo(ListInfoResponse $list_info) + public function setListInfo($list_info) { if (is_null($list_info)) { - throw new InvalidArgumentException('non-nullable list_info cannot be null'); + throw new \InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -374,7 +386,7 @@ public function setListInfo(ListInfoResponse $list_info) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -384,26 +396,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings warnings * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -412,11 +425,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -427,8 +440,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -441,9 +456,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -451,15 +468,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -485,3 +502,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamParentResponse.php b/sdks/php/src/Model/TeamParentResponse.php index d0d447285..7c4d355cd 100644 --- a/sdks/php/src/Model/TeamParentResponse.php +++ b/sdks/php/src/Model/TeamParentResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,68 +29,67 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamParentResponse Class Doc Comment * * @category Class * @description Information about the parent team if a team has one, set to `null` otherwise. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamParentResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TeamParentResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamParentResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team_id' => 'string', - 'name' => 'string', + 'name' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team_id' => null, - 'name' => null, + 'name' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'team_id' => false, - 'name' => false, + 'name' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -163,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'team_id' => 'team_id', - 'name' => 'name', + 'name' => 'name' ]; /** @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'team_id' => 'setTeamId', - 'name' => 'setName', + 'name' => 'setName' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'team_id' => 'getTeamId', - 'name' => 'getName', + 'name' => 'getName' ]; /** @@ -227,6 +236,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -246,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamParentResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamParentResponse { /** @var TeamParentResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamParentResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -289,7 +300,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -303,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets team_id * @@ -320,10 +334,10 @@ public function getTeamId() * * @return self */ - public function setTeamId(?string $team_id) + public function setTeamId($team_id) { if (is_null($team_id)) { - throw new InvalidArgumentException('non-nullable team_id cannot be null'); + throw new \InvalidArgumentException('non-nullable team_id cannot be null'); } $this->container['team_id'] = $team_id; @@ -347,22 +361,23 @@ public function getName() * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -371,11 +386,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -386,8 +401,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -400,9 +417,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -410,15 +429,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -444,3 +463,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamRemoveMemberRequest.php b/sdks/php/src/Model/TeamRemoveMemberRequest.php index 6d7413255..9c066146e 100644 --- a/sdks/php/src/Model/TeamRemoveMemberRequest.php +++ b/sdks/php/src/Model/TeamRemoveMemberRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,76 +29,75 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamRemoveMemberRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamRemoveMemberRequest implements ModelInterface, ArrayAccess, JsonSerializable +class TeamRemoveMemberRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamRemoveMemberRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', 'new_owner_email_address' => 'string', 'new_team_id' => 'string', - 'new_role' => 'string', + 'new_role' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => 'email', 'new_owner_email_address' => 'email', 'new_team_id' => null, - 'new_role' => null, + 'new_role' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, 'new_owner_email_address' => false, 'new_team_id' => false, - 'new_role' => false, + 'new_role' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -121,6 +122,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -130,7 +133,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +143,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,6 +152,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -157,6 +163,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -174,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'email_address', 'new_owner_email_address' => 'new_owner_email_address', 'new_team_id' => 'new_team_id', - 'new_role' => 'new_role', + 'new_role' => 'new_role' ]; /** @@ -187,7 +196,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'setEmailAddress', 'new_owner_email_address' => 'setNewOwnerEmailAddress', 'new_team_id' => 'setNewTeamId', - 'new_role' => 'setNewRole', + 'new_role' => 'setNewRole' ]; /** @@ -200,7 +209,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'getEmailAddress', 'new_owner_email_address' => 'getNewOwnerEmailAddress', 'new_team_id' => 'getNewTeamId', - 'new_role' => 'getNewRole', + 'new_role' => 'getNewRole' ]; /** @@ -286,33 +295,34 @@ public function __construct(array $data = null) $this->setIfExists('new_role', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamRemoveMemberRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamRemoveMemberRequest { /** @var TeamRemoveMemberRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamRemoveMemberRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -354,6 +364,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account_id * @@ -371,10 +382,10 @@ public function getAccountId() * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -398,10 +409,10 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -425,10 +436,10 @@ public function getNewOwnerEmailAddress() * * @return self */ - public function setNewOwnerEmailAddress(?string $new_owner_email_address) + public function setNewOwnerEmailAddress($new_owner_email_address) { if (is_null($new_owner_email_address)) { - throw new InvalidArgumentException('non-nullable new_owner_email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable new_owner_email_address cannot be null'); } $this->container['new_owner_email_address'] = $new_owner_email_address; @@ -448,14 +459,14 @@ public function getNewTeamId() /** * Sets new_team_id * - * @param string|null $new_team_id id of the new Team + * @param string|null $new_team_id Id of the new Team. * * @return self */ - public function setNewTeamId(?string $new_team_id) + public function setNewTeamId($new_team_id) { if (is_null($new_team_id)) { - throw new InvalidArgumentException('non-nullable new_team_id cannot be null'); + throw new \InvalidArgumentException('non-nullable new_team_id cannot be null'); } $this->container['new_team_id'] = $new_team_id; @@ -479,14 +490,14 @@ public function getNewRole() * * @return self */ - public function setNewRole(?string $new_role) + public function setNewRole($new_role) { if (is_null($new_role)) { - throw new InvalidArgumentException('non-nullable new_role cannot be null'); + throw new \InvalidArgumentException('non-nullable new_role cannot be null'); } $allowedValues = $this->getNewRoleAllowableValues(); if (!in_array($new_role, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'new_role', must be one of '%s'", $new_role, @@ -498,13 +509,14 @@ public function setNewRole(?string $new_role) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -513,11 +525,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -528,8 +540,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -542,9 +556,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -552,15 +568,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -586,3 +602,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamResponse.php b/sdks/php/src/Model/TeamResponse.php index 402916a49..8c22319a0 100644 --- a/sdks/php/src/Model/TeamResponse.php +++ b/sdks/php/src/Model/TeamResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,74 +29,73 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamResponse Class Doc Comment * * @category Class * @description Contains information about your team and its members - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TeamResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', 'accounts' => '\Dropbox\Sign\Model\AccountResponse[]', 'invited_accounts' => '\Dropbox\Sign\Model\AccountResponse[]', - 'invited_emails' => 'string[]', + 'invited_emails' => 'string[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, 'accounts' => null, 'invited_accounts' => null, - 'invited_emails' => null, + 'invited_emails' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'name' => false, 'accounts' => false, 'invited_accounts' => false, - 'invited_emails' => false, + 'invited_emails' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,6 +120,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -128,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -138,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -147,6 +150,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -155,6 +161,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'accounts' => 'accounts', 'invited_accounts' => 'invited_accounts', - 'invited_emails' => 'invited_emails', + 'invited_emails' => 'invited_emails' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'accounts' => 'setAccounts', 'invited_accounts' => 'setInvitedAccounts', - 'invited_emails' => 'setInvitedEmails', + 'invited_emails' => 'setInvitedEmails' ]; /** @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'accounts' => 'getAccounts', 'invited_accounts' => 'getInvitedAccounts', - 'invited_emails' => 'getInvitedEmails', + 'invited_emails' => 'getInvitedEmails' ]; /** @@ -239,6 +248,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -260,33 +270,34 @@ public function __construct(array $data = null) $this->setIfExists('invited_emails', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamResponse { /** @var TeamResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -303,7 +314,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -317,6 +330,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -334,10 +348,10 @@ public function getName() * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -347,7 +361,7 @@ public function setName(?string $name) /** * Gets accounts * - * @return AccountResponse[]|null + * @return \Dropbox\Sign\Model\AccountResponse[]|null */ public function getAccounts() { @@ -357,14 +371,14 @@ public function getAccounts() /** * Sets accounts * - * @param AccountResponse[]|null $accounts accounts + * @param \Dropbox\Sign\Model\AccountResponse[]|null $accounts accounts * * @return self */ - public function setAccounts(?array $accounts) + public function setAccounts($accounts) { if (is_null($accounts)) { - throw new InvalidArgumentException('non-nullable accounts cannot be null'); + throw new \InvalidArgumentException('non-nullable accounts cannot be null'); } $this->container['accounts'] = $accounts; @@ -374,7 +388,7 @@ public function setAccounts(?array $accounts) /** * Gets invited_accounts * - * @return AccountResponse[]|null + * @return \Dropbox\Sign\Model\AccountResponse[]|null */ public function getInvitedAccounts() { @@ -384,14 +398,14 @@ public function getInvitedAccounts() /** * Sets invited_accounts * - * @param AccountResponse[]|null $invited_accounts A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. + * @param \Dropbox\Sign\Model\AccountResponse[]|null $invited_accounts A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. * * @return self */ - public function setInvitedAccounts(?array $invited_accounts) + public function setInvitedAccounts($invited_accounts) { if (is_null($invited_accounts)) { - throw new InvalidArgumentException('non-nullable invited_accounts cannot be null'); + throw new \InvalidArgumentException('non-nullable invited_accounts cannot be null'); } $this->container['invited_accounts'] = $invited_accounts; @@ -411,26 +425,27 @@ public function getInvitedEmails() /** * Sets invited_emails * - * @param string[]|null $invited_emails a list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account + * @param string[]|null $invited_emails A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. * * @return self */ - public function setInvitedEmails(?array $invited_emails) + public function setInvitedEmails($invited_emails) { if (is_null($invited_emails)) { - throw new InvalidArgumentException('non-nullable invited_emails cannot be null'); + throw new \InvalidArgumentException('non-nullable invited_emails cannot be null'); } $this->container['invited_emails'] = $invited_emails; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -439,11 +454,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -454,8 +469,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -468,9 +485,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -478,15 +497,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -512,3 +531,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamSubTeamsResponse.php b/sdks/php/src/Model/TeamSubTeamsResponse.php index e3e9206c2..f4a3bc91a 100644 --- a/sdks/php/src/Model/TeamSubTeamsResponse.php +++ b/sdks/php/src/Model/TeamSubTeamsResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamSubTeamsResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamSubTeamsResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TeamSubTeamsResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamSubTeamsResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'sub_teams' => '\Dropbox\Sign\Model\SubTeamResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'sub_teams' => null, 'list_info' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'sub_teams' => false, 'list_info' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'sub_teams' => 'sub_teams', 'list_info' => 'list_info', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'sub_teams' => 'setSubTeams', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'sub_teams' => 'getSubTeams', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamSubTeamsResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamSubTeamsResponse { /** @var TeamSubTeamsResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamSubTeamsResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,10 +328,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets sub_teams * - * @return SubTeamResponse[] + * @return \Dropbox\Sign\Model\SubTeamResponse[] */ public function getSubTeams() { @@ -330,14 +342,14 @@ public function getSubTeams() /** * Sets sub_teams * - * @param SubTeamResponse[] $sub_teams contains a list with sub teams + * @param \Dropbox\Sign\Model\SubTeamResponse[] $sub_teams Contains a list with sub teams. * * @return self */ - public function setSubTeams(array $sub_teams) + public function setSubTeams($sub_teams) { if (is_null($sub_teams)) { - throw new InvalidArgumentException('non-nullable sub_teams cannot be null'); + throw new \InvalidArgumentException('non-nullable sub_teams cannot be null'); } $this->container['sub_teams'] = $sub_teams; @@ -347,7 +359,7 @@ public function setSubTeams(array $sub_teams) /** * Gets list_info * - * @return ListInfoResponse + * @return \Dropbox\Sign\Model\ListInfoResponse */ public function getListInfo() { @@ -357,14 +369,14 @@ public function getListInfo() /** * Sets list_info * - * @param ListInfoResponse $list_info list_info + * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo(ListInfoResponse $list_info) + public function setListInfo($list_info) { if (is_null($list_info)) { - throw new InvalidArgumentException('non-nullable list_info cannot be null'); + throw new \InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -374,7 +386,7 @@ public function setListInfo(ListInfoResponse $list_info) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -384,26 +396,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings warnings * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -412,11 +425,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -427,8 +440,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -441,9 +456,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -451,15 +468,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -485,3 +502,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TeamUpdateRequest.php b/sdks/php/src/Model/TeamUpdateRequest.php index 6606b7676..ad86dbe8f 100644 --- a/sdks/php/src/Model/TeamUpdateRequest.php +++ b/sdks/php/src/Model/TeamUpdateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TeamUpdateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class TeamUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamUpdateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'name' => 'string', + 'name' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'name' => null, + 'name' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'name' => false, + 'name' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'name' => 'name', + 'name' => 'name' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'name' => 'setName', + 'name' => 'setName' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'name' => 'getName', + 'name' => 'getName' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TeamUpdateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TeamUpdateRequest { /** @var TeamUpdateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TeamUpdateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +292,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -295,6 +308,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -308,26 +322,27 @@ public function getName() /** * Sets name * - * @param string|null $name the name of your Team + * @param string|null $name The name of your Team. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -336,11 +351,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -351,8 +366,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -365,9 +382,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -375,15 +394,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -409,3 +428,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateAddUserRequest.php b/sdks/php/src/Model/TemplateAddUserRequest.php index ea87103ad..f109a3747 100644 --- a/sdks/php/src/Model/TemplateAddUserRequest.php +++ b/sdks/php/src/Model/TemplateAddUserRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateAddUserRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateAddUserRequest implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateAddUserRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateAddUserRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', - 'skip_notification' => 'bool', + 'skip_notification' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => 'email', - 'skip_notification' => null, + 'skip_notification' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, - 'skip_notification' => false, + 'skip_notification' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'account_id' => 'account_id', 'email_address' => 'email_address', - 'skip_notification' => 'skip_notification', + 'skip_notification' => 'skip_notification' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'account_id' => 'setAccountId', 'email_address' => 'setEmailAddress', - 'skip_notification' => 'setSkipNotification', + 'skip_notification' => 'setSkipNotification' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'account_id' => 'getAccountId', 'email_address' => 'getEmailAddress', - 'skip_notification' => 'getSkipNotification', + 'skip_notification' => 'getSkipNotification' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('skip_notification', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateAddUserRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateAddUserRequest { /** @var TemplateAddUserRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateAddUserRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -295,7 +306,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -309,6 +322,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account_id * @@ -326,10 +340,10 @@ public function getAccountId() * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -353,10 +367,10 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -380,22 +394,23 @@ public function getSkipNotification() * * @return self */ - public function setSkipNotification(?bool $skip_notification) + public function setSkipNotification($skip_notification) { if (is_null($skip_notification)) { - throw new InvalidArgumentException('non-nullable skip_notification cannot be null'); + throw new \InvalidArgumentException('non-nullable skip_notification cannot be null'); } $this->container['skip_notification'] = $skip_notification; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -404,11 +419,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -419,8 +434,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -433,9 +450,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -443,15 +462,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -477,3 +496,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php index fe626a83a..580875bc3 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateCreateEmbeddedDraftRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateEmbeddedDraftRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'files' => '\SplFileObject[]', @@ -82,16 +82,16 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'subject' => 'string', 'test_mode' => 'bool', 'title' => 'string', - 'use_preexisting_fields' => 'bool', + 'use_preexisting_fields' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'files' => 'binary', @@ -117,14 +117,14 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'subject' => null, 'test_mode' => null, 'title' => null, - 'use_preexisting_fields' => null, + 'use_preexisting_fields' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'files' => false, @@ -150,14 +150,14 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'subject' => false, 'test_mode' => false, 'title' => false, - 'use_preexisting_fields' => false, + 'use_preexisting_fields' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -182,6 +182,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -191,7 +193,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -201,7 +203,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -210,6 +212,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -218,6 +223,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -255,7 +263,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'subject', 'test_mode' => 'test_mode', 'title' => 'title', - 'use_preexisting_fields' => 'use_preexisting_fields', + 'use_preexisting_fields' => 'use_preexisting_fields' ]; /** @@ -288,7 +296,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'setSubject', 'test_mode' => 'setTestMode', 'title' => 'setTitle', - 'use_preexisting_fields' => 'setUsePreexistingFields', + 'use_preexisting_fields' => 'setUsePreexistingFields' ]; /** @@ -321,7 +329,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'getSubject', 'test_mode' => 'getTestMode', 'title' => 'getTitle', - 'use_preexisting_fields' => 'getUsePreexistingFields', + 'use_preexisting_fields' => 'getUsePreexistingFields' ]; /** @@ -365,6 +373,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -407,33 +416,34 @@ public function __construct(array $data = null) $this->setIfExists('use_preexisting_fields', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateCreateEmbeddedDraftRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateCreateEmbeddedDraftRequest { /** @var TemplateCreateEmbeddedDraftRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateCreateEmbeddedDraftRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -477,6 +487,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets client_id * @@ -494,10 +505,10 @@ public function getClientId() * * @return self */ - public function setClientId(string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -507,7 +518,7 @@ public function setClientId(string $client_id) /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -517,14 +528,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -548,10 +559,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -571,14 +582,14 @@ public function getAllowCcs() /** * Sets allow_ccs * - * @param bool|null $allow_ccs this allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template + * @param bool|null $allow_ccs This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. * * @return self */ - public function setAllowCcs(?bool $allow_ccs) + public function setAllowCcs($allow_ccs) { if (is_null($allow_ccs)) { - throw new InvalidArgumentException('non-nullable allow_ccs cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_ccs cannot be null'); } $this->container['allow_ccs'] = $allow_ccs; @@ -602,10 +613,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign(?bool $allow_reassign) + public function setAllowReassign($allow_reassign) { if (is_null($allow_reassign)) { - throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -615,7 +626,7 @@ public function setAllowReassign(?bool $allow_reassign) /** * Gets attachments * - * @return SubAttachment[]|null + * @return \Dropbox\Sign\Model\SubAttachment[]|null */ public function getAttachments() { @@ -625,14 +636,14 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments(?array $attachments) + public function setAttachments($attachments) { if (is_null($attachments)) { - throw new InvalidArgumentException('non-nullable attachments cannot be null'); + throw new \InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -656,10 +667,10 @@ public function getCcRoles() * * @return self */ - public function setCcRoles(?array $cc_roles) + public function setCcRoles($cc_roles) { if (is_null($cc_roles)) { - throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); + throw new \InvalidArgumentException('non-nullable cc_roles cannot be null'); } $this->container['cc_roles'] = $cc_roles; @@ -669,7 +680,7 @@ public function setCcRoles(?array $cc_roles) /** * Gets editor_options * - * @return SubEditorOptions|null + * @return \Dropbox\Sign\Model\SubEditorOptions|null */ public function getEditorOptions() { @@ -679,14 +690,14 @@ public function getEditorOptions() /** * Sets editor_options * - * @param SubEditorOptions|null $editor_options editor_options + * @param \Dropbox\Sign\Model\SubEditorOptions|null $editor_options editor_options * * @return self */ - public function setEditorOptions(?SubEditorOptions $editor_options) + public function setEditorOptions($editor_options) { if (is_null($editor_options)) { - throw new InvalidArgumentException('non-nullable editor_options cannot be null'); + throw new \InvalidArgumentException('non-nullable editor_options cannot be null'); } $this->container['editor_options'] = $editor_options; @@ -696,7 +707,7 @@ public function setEditorOptions(?SubEditorOptions $editor_options) /** * Gets field_options * - * @return SubFieldOptions|null + * @return \Dropbox\Sign\Model\SubFieldOptions|null */ public function getFieldOptions() { @@ -706,14 +717,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param SubFieldOptions|null $field_options field_options + * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions(?SubFieldOptions $field_options) + public function setFieldOptions($field_options) { if (is_null($field_options)) { - throw new InvalidArgumentException('non-nullable field_options cannot be null'); + throw new \InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -733,14 +744,14 @@ public function getForceSignerRoles() /** * Sets force_signer_roles * - * @param bool|null $force_signer_roles provide users the ability to review/edit the template signer roles + * @param bool|null $force_signer_roles Provide users the ability to review/edit the template signer roles. * * @return self */ - public function setForceSignerRoles(?bool $force_signer_roles) + public function setForceSignerRoles($force_signer_roles) { if (is_null($force_signer_roles)) { - throw new InvalidArgumentException('non-nullable force_signer_roles cannot be null'); + throw new \InvalidArgumentException('non-nullable force_signer_roles cannot be null'); } $this->container['force_signer_roles'] = $force_signer_roles; @@ -760,14 +771,14 @@ public function getForceSubjectMessage() /** * Sets force_subject_message * - * @param bool|null $force_subject_message provide users the ability to review/edit the template subject and message + * @param bool|null $force_subject_message Provide users the ability to review/edit the template subject and message. * * @return self */ - public function setForceSubjectMessage(?bool $force_subject_message) + public function setForceSubjectMessage($force_subject_message) { if (is_null($force_subject_message)) { - throw new InvalidArgumentException('non-nullable force_subject_message cannot be null'); + throw new \InvalidArgumentException('non-nullable force_subject_message cannot be null'); } $this->container['force_subject_message'] = $force_subject_message; @@ -777,7 +788,7 @@ public function setForceSubjectMessage(?bool $force_subject_message) /** * Gets form_field_groups * - * @return SubFormFieldGroup[]|null + * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -787,14 +798,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups(?array $form_field_groups) + public function setFormFieldGroups($form_field_groups) { if (is_null($form_field_groups)) { - throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -804,7 +815,7 @@ public function setFormFieldGroups(?array $form_field_groups) /** * Gets form_field_rules * - * @return SubFormFieldRule[]|null + * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -814,14 +825,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` + * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. * * @return self */ - public function setFormFieldRules(?array $form_field_rules) + public function setFormFieldRules($form_field_rules) { if (is_null($form_field_rules)) { - throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -831,7 +842,7 @@ public function setFormFieldRules(?array $form_field_rules) /** * Gets form_fields_per_document * - * @return SubFormFieldsPerDocumentBase[]|null + * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null */ public function getFormFieldsPerDocument() { @@ -841,14 +852,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument(?array $form_fields_per_document) + public function setFormFieldsPerDocument($form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -858,7 +869,7 @@ public function setFormFieldsPerDocument(?array $form_fields_per_document) /** * Gets merge_fields * - * @return SubMergeField[]|null + * @return \Dropbox\Sign\Model\SubMergeField[]|null */ public function getMergeFields() { @@ -868,14 +879,14 @@ public function getMergeFields() /** * Sets merge_fields * - * @param SubMergeField[]|null $merge_fields Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. + * @param \Dropbox\Sign\Model\SubMergeField[]|null $merge_fields Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. * * @return self */ - public function setMergeFields(?array $merge_fields) + public function setMergeFields($merge_fields) { if (is_null($merge_fields)) { - throw new InvalidArgumentException('non-nullable merge_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable merge_fields cannot be null'); } $this->container['merge_fields'] = $merge_fields; @@ -895,17 +906,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the default template email message + * @param string|null $message The default template email message. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling TemplateCreateEmbeddedDraftRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling TemplateCreateEmbeddedDraftRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -930,12 +941,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -958,10 +970,10 @@ public function getShowPreview() * * @return self */ - public function setShowPreview(?bool $show_preview) + public function setShowPreview($show_preview) { if (is_null($show_preview)) { - throw new InvalidArgumentException('non-nullable show_preview cannot be null'); + throw new \InvalidArgumentException('non-nullable show_preview cannot be null'); } $this->container['show_preview'] = $show_preview; @@ -981,14 +993,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden + * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. * * @return self */ - public function setShowProgressStepper(?bool $show_progress_stepper) + public function setShowProgressStepper($show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -998,7 +1010,7 @@ public function setShowProgressStepper(?bool $show_progress_stepper) /** * Gets signer_roles * - * @return SubTemplateRole[]|null + * @return \Dropbox\Sign\Model\SubTemplateRole[]|null */ public function getSignerRoles() { @@ -1008,14 +1020,14 @@ public function getSignerRoles() /** * Sets signer_roles * - * @param SubTemplateRole[]|null $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template + * @param \Dropbox\Sign\Model\SubTemplateRole[]|null $signer_roles An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. * * @return self */ - public function setSignerRoles(?array $signer_roles) + public function setSignerRoles($signer_roles) { if (is_null($signer_roles)) { - throw new InvalidArgumentException('non-nullable signer_roles cannot be null'); + throw new \InvalidArgumentException('non-nullable signer_roles cannot be null'); } $this->container['signer_roles'] = $signer_roles; @@ -1039,10 +1051,10 @@ public function getSkipMeNow() * * @return self */ - public function setSkipMeNow(?bool $skip_me_now) + public function setSkipMeNow($skip_me_now) { if (is_null($skip_me_now)) { - throw new InvalidArgumentException('non-nullable skip_me_now cannot be null'); + throw new \InvalidArgumentException('non-nullable skip_me_now cannot be null'); } $this->container['skip_me_now'] = $skip_me_now; @@ -1062,17 +1074,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the template title (alias) + * @param string|null $subject The template title (alias). * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 200) { - throw new InvalidArgumentException('invalid length for $subject when calling TemplateCreateEmbeddedDraftRequest., must be smaller than or equal to 200.'); + if ((mb_strlen($subject) > 200)) { + throw new \InvalidArgumentException('invalid length for $subject when calling TemplateCreateEmbeddedDraftRequest., must be smaller than or equal to 200.'); } $this->container['subject'] = $subject; @@ -1097,10 +1109,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1120,14 +1132,14 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title you want to assign to the SignatureRequest + * @param string|null $title The title you want to assign to the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -1147,26 +1159,27 @@ public function getUsePreexistingFields() /** * Sets use_preexisting_fields * - * @param bool|null $use_preexisting_fields enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`) + * @param bool|null $use_preexisting_fields Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). * * @return self */ - public function setUsePreexistingFields(?bool $use_preexisting_fields) + public function setUsePreexistingFields($use_preexisting_fields) { if (is_null($use_preexisting_fields)) { - throw new InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); } $this->container['use_preexisting_fields'] = $use_preexisting_fields; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1175,11 +1188,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1190,8 +1203,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1204,9 +1219,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1214,15 +1231,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1248,3 +1265,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php index 49266a669..7ef9d7a64 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateCreateEmbeddedDraftResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateEmbeddedDraftResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateCreateEmbeddedDraftResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateEmbeddedDraftResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template' => '\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'template' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'template' => 'template', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'template' => 'setTemplate', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'template' => 'getTemplate', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateCreateEmbeddedDraftResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateCreateEmbeddedDraftResponse { /** @var TemplateCreateEmbeddedDraftResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateCreateEmbeddedDraftResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template * - * @return TemplateCreateEmbeddedDraftResponseTemplate + * @return \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate */ public function getTemplate() { @@ -320,14 +332,14 @@ public function getTemplate() /** * Sets template * - * @param TemplateCreateEmbeddedDraftResponseTemplate $template template + * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate $template template * * @return self */ - public function setTemplate(TemplateCreateEmbeddedDraftResponseTemplate $template) + public function setTemplate($template) { if (is_null($template)) { - throw new InvalidArgumentException('non-nullable template cannot be null'); + throw new \InvalidArgumentException('non-nullable template cannot be null'); } $this->container['template'] = $template; @@ -337,7 +349,7 @@ public function setTemplate(TemplateCreateEmbeddedDraftResponseTemplate $templat /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php index 44031ce16..9e1345225 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,74 +29,73 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateCreateEmbeddedDraftResponseTemplate Class Doc Comment * * @category Class * @description Template object with parameters: `template_id`, `edit_url`, `expires_at`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateEmbeddedDraftResponseTemplate implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateCreateEmbeddedDraftResponseTemplate implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateEmbeddedDraftResponseTemplate'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_id' => 'string', 'edit_url' => 'string', 'expires_at' => 'int', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_id' => null, 'edit_url' => null, 'expires_at' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'template_id' => false, 'edit_url' => false, 'expires_at' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,6 +120,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -128,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -138,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -147,6 +150,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -155,6 +161,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'template_id', 'edit_url' => 'edit_url', 'expires_at' => 'expires_at', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'setTemplateId', 'edit_url' => 'setEditUrl', 'expires_at' => 'setExpiresAt', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'getTemplateId', 'edit_url' => 'getEditUrl', 'expires_at' => 'getExpiresAt', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -239,6 +248,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -260,33 +270,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateCreateEmbeddedDraftResponseTemplate { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateCreateEmbeddedDraftResponseTemplate { /** @var TemplateCreateEmbeddedDraftResponseTemplate */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateCreateEmbeddedDraftResponseTemplate::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -303,7 +314,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -317,6 +330,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template_id * @@ -330,14 +344,14 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string|null $template_id The id of the Template. * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId($template_id) { if (is_null($template_id)) { - throw new InvalidArgumentException('non-nullable template_id cannot be null'); + throw new \InvalidArgumentException('non-nullable template_id cannot be null'); } $this->container['template_id'] = $template_id; @@ -357,14 +371,14 @@ public function getEditUrl() /** * Sets edit_url * - * @param string|null $edit_url link to edit the template + * @param string|null $edit_url Link to edit the template. * * @return self */ - public function setEditUrl(?string $edit_url) + public function setEditUrl($edit_url) { if (is_null($edit_url)) { - throw new InvalidArgumentException('non-nullable edit_url cannot be null'); + throw new \InvalidArgumentException('non-nullable edit_url cannot be null'); } $this->container['edit_url'] = $edit_url; @@ -384,14 +398,14 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at when the link expires + * @param int|null $expires_at When the link expires. * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { - throw new InvalidArgumentException('non-nullable expires_at cannot be null'); + throw new \InvalidArgumentException('non-nullable expires_at cannot be null'); } $this->container['expires_at'] = $expires_at; @@ -401,7 +415,7 @@ public function setExpiresAt(?int $expires_at) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null * @deprecated */ public function getWarnings() @@ -412,27 +426,28 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self * @deprecated */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -441,11 +456,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -456,8 +471,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -470,9 +487,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -480,15 +499,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -514,3 +533,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateCreateRequest.php b/sdks/php/src/Model/TemplateCreateRequest.php index ec6890622..7f319bfa8 100644 --- a/sdks/php/src/Model/TemplateCreateRequest.php +++ b/sdks/php/src/Model/TemplateCreateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateCreateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'form_fields_per_document' => '\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]', 'signer_roles' => '\Dropbox\Sign\Model\SubTemplateRole[]', @@ -75,16 +75,16 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'subject' => 'string', 'test_mode' => 'bool', 'title' => 'string', - 'use_preexisting_fields' => 'bool', + 'use_preexisting_fields' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'form_fields_per_document' => null, 'signer_roles' => null, @@ -103,14 +103,14 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'subject' => null, 'test_mode' => null, 'title' => null, - 'use_preexisting_fields' => null, + 'use_preexisting_fields' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'form_fields_per_document' => false, 'signer_roles' => false, @@ -129,14 +129,14 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'subject' => false, 'test_mode' => false, 'title' => false, - 'use_preexisting_fields' => false, + 'use_preexisting_fields' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -161,6 +161,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -170,7 +172,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -180,7 +182,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -189,6 +191,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -197,6 +202,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -227,7 +235,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'subject', 'test_mode' => 'test_mode', 'title' => 'title', - 'use_preexisting_fields' => 'use_preexisting_fields', + 'use_preexisting_fields' => 'use_preexisting_fields' ]; /** @@ -253,7 +261,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'setSubject', 'test_mode' => 'setTestMode', 'title' => 'setTitle', - 'use_preexisting_fields' => 'setUsePreexistingFields', + 'use_preexisting_fields' => 'setUsePreexistingFields' ]; /** @@ -279,7 +287,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'getSubject', 'test_mode' => 'getTestMode', 'title' => 'getTitle', - 'use_preexisting_fields' => 'getUsePreexistingFields', + 'use_preexisting_fields' => 'getUsePreexistingFields' ]; /** @@ -323,6 +331,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -358,33 +367,34 @@ public function __construct(array $data = null) $this->setIfExists('use_preexisting_fields', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateCreateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateCreateRequest { /** @var TemplateCreateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateCreateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -431,10 +441,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets form_fields_per_document * - * @return SubFormFieldsPerDocumentBase[] + * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[] */ public function getFormFieldsPerDocument() { @@ -444,14 +455,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param SubFormFieldsPerDocumentBase[] $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[] $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument(array $form_fields_per_document) + public function setFormFieldsPerDocument($form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -461,7 +472,7 @@ public function setFormFieldsPerDocument(array $form_fields_per_document) /** * Gets signer_roles * - * @return SubTemplateRole[] + * @return \Dropbox\Sign\Model\SubTemplateRole[] */ public function getSignerRoles() { @@ -471,14 +482,14 @@ public function getSignerRoles() /** * Sets signer_roles * - * @param SubTemplateRole[] $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template + * @param \Dropbox\Sign\Model\SubTemplateRole[] $signer_roles An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. * * @return self */ - public function setSignerRoles(array $signer_roles) + public function setSignerRoles($signer_roles) { if (is_null($signer_roles)) { - throw new InvalidArgumentException('non-nullable signer_roles cannot be null'); + throw new \InvalidArgumentException('non-nullable signer_roles cannot be null'); } $this->container['signer_roles'] = $signer_roles; @@ -488,7 +499,7 @@ public function setSignerRoles(array $signer_roles) /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -498,14 +509,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -529,10 +540,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -556,10 +567,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign(?bool $allow_reassign) + public function setAllowReassign($allow_reassign) { if (is_null($allow_reassign)) { - throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -569,7 +580,7 @@ public function setAllowReassign(?bool $allow_reassign) /** * Gets attachments * - * @return SubAttachment[]|null + * @return \Dropbox\Sign\Model\SubAttachment[]|null */ public function getAttachments() { @@ -579,14 +590,14 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments(?array $attachments) + public function setAttachments($attachments) { if (is_null($attachments)) { - throw new InvalidArgumentException('non-nullable attachments cannot be null'); + throw new \InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -610,10 +621,10 @@ public function getCcRoles() * * @return self */ - public function setCcRoles(?array $cc_roles) + public function setCcRoles($cc_roles) { if (is_null($cc_roles)) { - throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); + throw new \InvalidArgumentException('non-nullable cc_roles cannot be null'); } $this->container['cc_roles'] = $cc_roles; @@ -637,10 +648,10 @@ public function getClientId() * * @return self */ - public function setClientId(?string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -650,7 +661,7 @@ public function setClientId(?string $client_id) /** * Gets field_options * - * @return SubFieldOptions|null + * @return \Dropbox\Sign\Model\SubFieldOptions|null */ public function getFieldOptions() { @@ -660,14 +671,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param SubFieldOptions|null $field_options field_options + * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions(?SubFieldOptions $field_options) + public function setFieldOptions($field_options) { if (is_null($field_options)) { - throw new InvalidArgumentException('non-nullable field_options cannot be null'); + throw new \InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -677,7 +688,7 @@ public function setFieldOptions(?SubFieldOptions $field_options) /** * Gets form_field_groups * - * @return SubFormFieldGroup[]|null + * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -687,14 +698,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups(?array $form_field_groups) + public function setFormFieldGroups($form_field_groups) { if (is_null($form_field_groups)) { - throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -704,7 +715,7 @@ public function setFormFieldGroups(?array $form_field_groups) /** * Gets form_field_rules * - * @return SubFormFieldRule[]|null + * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -714,14 +725,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` + * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. * * @return self */ - public function setFormFieldRules(?array $form_field_rules) + public function setFormFieldRules($form_field_rules) { if (is_null($form_field_rules)) { - throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -731,7 +742,7 @@ public function setFormFieldRules(?array $form_field_rules) /** * Gets merge_fields * - * @return SubMergeField[]|null + * @return \Dropbox\Sign\Model\SubMergeField[]|null */ public function getMergeFields() { @@ -741,14 +752,14 @@ public function getMergeFields() /** * Sets merge_fields * - * @param SubMergeField[]|null $merge_fields Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. + * @param \Dropbox\Sign\Model\SubMergeField[]|null $merge_fields Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. * * @return self */ - public function setMergeFields(?array $merge_fields) + public function setMergeFields($merge_fields) { if (is_null($merge_fields)) { - throw new InvalidArgumentException('non-nullable merge_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable merge_fields cannot be null'); } $this->container['merge_fields'] = $merge_fields; @@ -768,17 +779,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the default template email message + * @param string|null $message The default template email message. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling TemplateCreateRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling TemplateCreateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -803,12 +814,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -827,17 +839,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the template title (alias) + * @param string|null $subject The template title (alias). * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 200) { - throw new InvalidArgumentException('invalid length for $subject when calling TemplateCreateRequest., must be smaller than or equal to 200.'); + if ((mb_strlen($subject) > 200)) { + throw new \InvalidArgumentException('invalid length for $subject when calling TemplateCreateRequest., must be smaller than or equal to 200.'); } $this->container['subject'] = $subject; @@ -862,10 +874,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -885,14 +897,14 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title you want to assign to the SignatureRequest + * @param string|null $title The title you want to assign to the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -912,26 +924,27 @@ public function getUsePreexistingFields() /** * Sets use_preexisting_fields * - * @param bool|null $use_preexisting_fields enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`) + * @param bool|null $use_preexisting_fields Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). * * @return self */ - public function setUsePreexistingFields(?bool $use_preexisting_fields) + public function setUsePreexistingFields($use_preexisting_fields) { if (is_null($use_preexisting_fields)) { - throw new InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); } $this->container['use_preexisting_fields'] = $use_preexisting_fields; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -940,11 +953,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -955,8 +968,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -969,9 +984,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -979,15 +996,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1013,3 +1030,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateCreateResponse.php b/sdks/php/src/Model/TemplateCreateResponse.php index e17ce910a..fd01c2708 100644 --- a/sdks/php/src/Model/TemplateCreateResponse.php +++ b/sdks/php/src/Model/TemplateCreateResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateCreateResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateCreateResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template' => '\Dropbox\Sign\Model\TemplateCreateResponseTemplate', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'template' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'template' => 'template', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'template' => 'setTemplate', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'template' => 'getTemplate', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateCreateResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateCreateResponse { /** @var TemplateCreateResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateCreateResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template * - * @return TemplateCreateResponseTemplate + * @return \Dropbox\Sign\Model\TemplateCreateResponseTemplate */ public function getTemplate() { @@ -320,14 +332,14 @@ public function getTemplate() /** * Sets template * - * @param TemplateCreateResponseTemplate $template template + * @param \Dropbox\Sign\Model\TemplateCreateResponseTemplate $template template * * @return self */ - public function setTemplate(TemplateCreateResponseTemplate $template) + public function setTemplate($template) { if (is_null($template)) { - throw new InvalidArgumentException('non-nullable template cannot be null'); + throw new \InvalidArgumentException('non-nullable template cannot be null'); } $this->container['template'] = $template; @@ -337,7 +349,7 @@ public function setTemplate(TemplateCreateResponseTemplate $template) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateCreateResponseTemplate.php b/sdks/php/src/Model/TemplateCreateResponseTemplate.php index 199aa3f74..4ab7c4a3a 100644 --- a/sdks/php/src/Model/TemplateCreateResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateResponseTemplate.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,65 +29,64 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateCreateResponseTemplate Class Doc Comment * * @category Class * @description Template object with parameters: `template_id`. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateResponseTemplate implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateCreateResponseTemplate implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateResponseTemplate'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'template_id' => 'string', + 'template_id' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'template_id' => null, + 'template_id' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'template_id' => false, + 'template_id' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,6 +111,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -119,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -129,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -138,6 +141,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -146,6 +152,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -159,7 +168,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'template_id' => 'template_id', + 'template_id' => 'template_id' ]; /** @@ -168,7 +177,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'template_id' => 'setTemplateId', + 'template_id' => 'setTemplateId' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'template_id' => 'getTemplateId', + 'template_id' => 'getTemplateId' ]; /** @@ -221,6 +230,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -239,33 +249,34 @@ public function __construct(array $data = null) $this->setIfExists('template_id', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateCreateResponseTemplate { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateCreateResponseTemplate { /** @var TemplateCreateResponseTemplate */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateCreateResponseTemplate::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -282,7 +293,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -296,6 +309,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template_id * @@ -309,26 +323,27 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string|null $template_id The id of the Template. * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId($template_id) { if (is_null($template_id)) { - throw new InvalidArgumentException('non-nullable template_id cannot be null'); + throw new \InvalidArgumentException('non-nullable template_id cannot be null'); } $this->container['template_id'] = $template_id; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -337,11 +352,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -352,8 +367,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -366,9 +383,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -376,15 +395,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -410,3 +429,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateEditResponse.php b/sdks/php/src/Model/TemplateEditResponse.php index 0ef5462cf..940775371 100644 --- a/sdks/php/src/Model/TemplateEditResponse.php +++ b/sdks/php/src/Model/TemplateEditResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateEditResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateEditResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateEditResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateEditResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'template_id' => 'string', + 'template_id' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'template_id' => null, + 'template_id' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'template_id' => false, + 'template_id' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'template_id' => 'template_id', + 'template_id' => 'template_id' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'template_id' => 'setTemplateId', + 'template_id' => 'setTemplateId' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'template_id' => 'getTemplateId', + 'template_id' => 'getTemplateId' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('template_id', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateEditResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateEditResponse { /** @var TemplateEditResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateEditResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,6 +311,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template_id * @@ -313,26 +325,27 @@ public function getTemplateId() /** * Sets template_id * - * @param string $template_id the id of the Template + * @param string $template_id The id of the Template. * * @return self */ - public function setTemplateId(string $template_id) + public function setTemplateId($template_id) { if (is_null($template_id)) { - throw new InvalidArgumentException('non-nullable template_id cannot be null'); + throw new \InvalidArgumentException('non-nullable template_id cannot be null'); } $this->container['template_id'] = $template_id; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -341,11 +354,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -356,8 +369,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -370,9 +385,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -380,15 +397,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -414,3 +431,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateGetResponse.php b/sdks/php/src/Model/TemplateGetResponse.php index 45b89ba15..6d8280c8b 100644 --- a/sdks/php/src/Model/TemplateGetResponse.php +++ b/sdks/php/src/Model/TemplateGetResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateGetResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateGetResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template' => '\Dropbox\Sign\Model\TemplateResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'template' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'template' => 'template', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'template' => 'setTemplate', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'template' => 'getTemplate', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateGetResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateGetResponse { /** @var TemplateGetResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateGetResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template * - * @return TemplateResponse + * @return \Dropbox\Sign\Model\TemplateResponse */ public function getTemplate() { @@ -320,14 +332,14 @@ public function getTemplate() /** * Sets template * - * @param TemplateResponse $template template + * @param \Dropbox\Sign\Model\TemplateResponse $template template * * @return self */ - public function setTemplate(TemplateResponse $template) + public function setTemplate($template) { if (is_null($template)) { - throw new InvalidArgumentException('non-nullable template cannot be null'); + throw new \InvalidArgumentException('non-nullable template cannot be null'); } $this->container['template'] = $template; @@ -337,7 +349,7 @@ public function setTemplate(TemplateResponse $template) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateListResponse.php b/sdks/php/src/Model/TemplateListResponse.php index 49974663e..08656a057 100644 --- a/sdks/php/src/Model/TemplateListResponse.php +++ b/sdks/php/src/Model/TemplateListResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,70 +29,69 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateListResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateListResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateListResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'templates' => '\Dropbox\Sign\Model\TemplateResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'templates' => null, 'list_info' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'templates' => false, 'list_info' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,6 +116,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -124,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,6 +146,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -151,6 +157,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'templates' => 'templates', 'list_info' => 'list_info', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'templates' => 'setTemplates', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -188,7 +197,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'templates' => 'getTemplates', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -232,6 +241,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -252,33 +262,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateListResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateListResponse { /** @var TemplateListResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateListResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,10 +328,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets templates * - * @return TemplateResponse[] + * @return \Dropbox\Sign\Model\TemplateResponse[] */ public function getTemplates() { @@ -330,14 +342,14 @@ public function getTemplates() /** * Sets templates * - * @param TemplateResponse[] $templates list of templates that the API caller has access to + * @param \Dropbox\Sign\Model\TemplateResponse[] $templates List of templates that the API caller has access to. * * @return self */ - public function setTemplates(array $templates) + public function setTemplates($templates) { if (is_null($templates)) { - throw new InvalidArgumentException('non-nullable templates cannot be null'); + throw new \InvalidArgumentException('non-nullable templates cannot be null'); } $this->container['templates'] = $templates; @@ -347,7 +359,7 @@ public function setTemplates(array $templates) /** * Gets list_info * - * @return ListInfoResponse + * @return \Dropbox\Sign\Model\ListInfoResponse */ public function getListInfo() { @@ -357,14 +369,14 @@ public function getListInfo() /** * Sets list_info * - * @param ListInfoResponse $list_info list_info + * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo(ListInfoResponse $list_info) + public function setListInfo($list_info) { if (is_null($list_info)) { - throw new InvalidArgumentException('non-nullable list_info cannot be null'); + throw new \InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -374,7 +386,7 @@ public function setListInfo(ListInfoResponse $list_info) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -384,26 +396,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -412,11 +425,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -427,8 +440,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -441,9 +456,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -451,15 +468,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -485,3 +502,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateRemoveUserRequest.php b/sdks/php/src/Model/TemplateRemoveUserRequest.php index d7a8582f9..79b22b8c3 100644 --- a/sdks/php/src/Model/TemplateRemoveUserRequest.php +++ b/sdks/php/src/Model/TemplateRemoveUserRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateRemoveUserRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateRemoveUserRequest implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateRemoveUserRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateRemoveUserRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', - 'email_address' => 'string', + 'email_address' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, - 'email_address' => 'email', + 'email_address' => 'email' ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account_id' => false, - 'email_address' => false, + 'email_address' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account_id' => 'account_id', - 'email_address' => 'email_address', + 'email_address' => 'email_address' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account_id' => 'setAccountId', - 'email_address' => 'setEmailAddress', + 'email_address' => 'setEmailAddress' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account_id' => 'getAccountId', - 'email_address' => 'getEmailAddress', + 'email_address' => 'getEmailAddress' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateRemoveUserRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateRemoveUserRequest { /** @var TemplateRemoveUserRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateRemoveUserRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -288,7 +299,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -302,6 +315,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account_id * @@ -319,10 +333,10 @@ public function getAccountId() * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -346,22 +360,23 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -370,11 +385,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -385,8 +400,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -399,9 +416,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -409,15 +428,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -443,3 +462,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponse.php b/sdks/php/src/Model/TemplateResponse.php index 6bc51cfb9..340595d57 100644 --- a/sdks/php/src/Model/TemplateResponse.php +++ b/sdks/php/src/Model/TemplateResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponse Class Doc Comment * * @category Class * @description Contains information about the templates you and your team have created. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_id' => 'string', 'title' => 'string', @@ -73,16 +74,16 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', 'named_form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', 'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]', - 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', + 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_id' => null, 'title' => null, @@ -99,14 +100,14 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'custom_fields' => null, 'named_form_fields' => null, 'accounts' => null, - 'attachments' => null, + 'attachments' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'template_id' => false, 'title' => false, @@ -123,14 +124,14 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'custom_fields' => true, 'named_form_fields' => true, 'accounts' => false, - 'attachments' => false, + 'attachments' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -155,6 +156,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -164,7 +167,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -174,7 +177,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -183,6 +186,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -191,6 +197,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -219,7 +228,7 @@ public function isNullableSetToNull(string $property): bool 'custom_fields' => 'custom_fields', 'named_form_fields' => 'named_form_fields', 'accounts' => 'accounts', - 'attachments' => 'attachments', + 'attachments' => 'attachments' ]; /** @@ -243,7 +252,7 @@ public function isNullableSetToNull(string $property): bool 'custom_fields' => 'setCustomFields', 'named_form_fields' => 'setNamedFormFields', 'accounts' => 'setAccounts', - 'attachments' => 'setAttachments', + 'attachments' => 'setAttachments' ]; /** @@ -267,7 +276,7 @@ public function isNullableSetToNull(string $property): bool 'custom_fields' => 'getCustomFields', 'named_form_fields' => 'getNamedFormFields', 'accounts' => 'getAccounts', - 'attachments' => 'getAttachments', + 'attachments' => 'getAttachments' ]; /** @@ -311,6 +320,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -344,33 +354,34 @@ public function __construct(array $data = null) $this->setIfExists('attachments', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponse { /** @var TemplateResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -387,7 +398,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -401,6 +414,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template_id * @@ -414,14 +428,14 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string|null $template_id The id of the Template. * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId($template_id) { if (is_null($template_id)) { - throw new InvalidArgumentException('non-nullable template_id cannot be null'); + throw new \InvalidArgumentException('non-nullable template_id cannot be null'); } $this->container['template_id'] = $template_id; @@ -445,10 +459,10 @@ public function getTitle() * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -472,10 +486,10 @@ public function getMessage() * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } $this->container['message'] = $message; @@ -495,14 +509,14 @@ public function getUpdatedAt() /** * Sets updated_at * - * @param int|null $updated_at time the template was last updated + * @param int|null $updated_at Time the template was last updated. * * @return self */ - public function setUpdatedAt(?int $updated_at) + public function setUpdatedAt($updated_at) { if (is_null($updated_at)) { - throw new InvalidArgumentException('non-nullable updated_at cannot be null'); + throw new \InvalidArgumentException('non-nullable updated_at cannot be null'); } $this->container['updated_at'] = $updated_at; @@ -526,14 +540,14 @@ public function getIsEmbedded() * * @return self */ - public function setIsEmbedded(?bool $is_embedded) + public function setIsEmbedded($is_embedded) { if (is_null($is_embedded)) { array_push($this->openAPINullablesSetToNull, 'is_embedded'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('is_embedded', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -556,14 +570,14 @@ public function getIsCreator() /** * Sets is_creator * - * @param bool|null $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member + * @param bool|null $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member. * * @return self */ - public function setIsCreator(?bool $is_creator) + public function setIsCreator($is_creator) { if (is_null($is_creator)) { - throw new InvalidArgumentException('non-nullable is_creator cannot be null'); + throw new \InvalidArgumentException('non-nullable is_creator cannot be null'); } $this->container['is_creator'] = $is_creator; @@ -583,14 +597,14 @@ public function getCanEdit() /** * Sets can_edit * - * @param bool|null $can_edit indicates whether edit rights have been granted to you by the owner (always `true` if that's you) + * @param bool|null $can_edit Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). * * @return self */ - public function setCanEdit(?bool $can_edit) + public function setCanEdit($can_edit) { if (is_null($can_edit)) { - throw new InvalidArgumentException('non-nullable can_edit cannot be null'); + throw new \InvalidArgumentException('non-nullable can_edit cannot be null'); } $this->container['can_edit'] = $can_edit; @@ -614,10 +628,10 @@ public function getIsLocked() * * @return self */ - public function setIsLocked(?bool $is_locked) + public function setIsLocked($is_locked) { if (is_null($is_locked)) { - throw new InvalidArgumentException('non-nullable is_locked cannot be null'); + throw new \InvalidArgumentException('non-nullable is_locked cannot be null'); } $this->container['is_locked'] = $is_locked; @@ -637,14 +651,14 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata the metadata attached to the template + * @param array|null $metadata The metadata attached to the template. * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } $this->container['metadata'] = $metadata; @@ -654,7 +668,7 @@ public function setMetadata(?array $metadata) /** * Gets signer_roles * - * @return TemplateResponseSignerRole[]|null + * @return \Dropbox\Sign\Model\TemplateResponseSignerRole[]|null */ public function getSignerRoles() { @@ -664,14 +678,14 @@ public function getSignerRoles() /** * Sets signer_roles * - * @param TemplateResponseSignerRole[]|null $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template + * @param \Dropbox\Sign\Model\TemplateResponseSignerRole[]|null $signer_roles An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. * * @return self */ - public function setSignerRoles(?array $signer_roles) + public function setSignerRoles($signer_roles) { if (is_null($signer_roles)) { - throw new InvalidArgumentException('non-nullable signer_roles cannot be null'); + throw new \InvalidArgumentException('non-nullable signer_roles cannot be null'); } $this->container['signer_roles'] = $signer_roles; @@ -681,7 +695,7 @@ public function setSignerRoles(?array $signer_roles) /** * Gets cc_roles * - * @return TemplateResponseCCRole[]|null + * @return \Dropbox\Sign\Model\TemplateResponseCCRole[]|null */ public function getCcRoles() { @@ -691,14 +705,14 @@ public function getCcRoles() /** * Sets cc_roles * - * @param TemplateResponseCCRole[]|null $cc_roles an array of the designated CC roles that must be specified when sending a SignatureRequest using this Template + * @param \Dropbox\Sign\Model\TemplateResponseCCRole[]|null $cc_roles An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. * * @return self */ - public function setCcRoles(?array $cc_roles) + public function setCcRoles($cc_roles) { if (is_null($cc_roles)) { - throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); + throw new \InvalidArgumentException('non-nullable cc_roles cannot be null'); } $this->container['cc_roles'] = $cc_roles; @@ -708,7 +722,7 @@ public function setCcRoles(?array $cc_roles) /** * Gets documents * - * @return TemplateResponseDocument[]|null + * @return \Dropbox\Sign\Model\TemplateResponseDocument[]|null */ public function getDocuments() { @@ -718,14 +732,14 @@ public function getDocuments() /** * Sets documents * - * @param TemplateResponseDocument[]|null $documents An array describing each document associated with this Template. Includes form field data for each document. + * @param \Dropbox\Sign\Model\TemplateResponseDocument[]|null $documents An array describing each document associated with this Template. Includes form field data for each document. * * @return self */ - public function setDocuments(?array $documents) + public function setDocuments($documents) { if (is_null($documents)) { - throw new InvalidArgumentException('non-nullable documents cannot be null'); + throw new \InvalidArgumentException('non-nullable documents cannot be null'); } $this->container['documents'] = $documents; @@ -735,7 +749,7 @@ public function setDocuments(?array $documents) /** * Gets custom_fields * - * @return TemplateResponseDocumentCustomFieldBase[]|null + * @return \Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]|null * @deprecated */ public function getCustomFields() @@ -746,19 +760,19 @@ public function getCustomFields() /** * Sets custom_fields * - * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * @param \Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]|null $custom_fields Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. * * @return self * @deprecated */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { array_push($this->openAPINullablesSetToNull, 'custom_fields'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('custom_fields', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -771,7 +785,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets named_form_fields * - * @return TemplateResponseDocumentFormFieldBase[]|null + * @return \Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]|null * @deprecated */ public function getNamedFormFields() @@ -782,19 +796,19 @@ public function getNamedFormFields() /** * Sets named_form_fields * - * @param TemplateResponseDocumentFormFieldBase[]|null $named_form_fields Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * @param \Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]|null $named_form_fields Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. * * @return self * @deprecated */ - public function setNamedFormFields(?array $named_form_fields) + public function setNamedFormFields($named_form_fields) { if (is_null($named_form_fields)) { array_push($this->openAPINullablesSetToNull, 'named_form_fields'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('named_form_fields', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -807,7 +821,7 @@ public function setNamedFormFields(?array $named_form_fields) /** * Gets accounts * - * @return TemplateResponseAccount[]|null + * @return \Dropbox\Sign\Model\TemplateResponseAccount[]|null */ public function getAccounts() { @@ -817,14 +831,14 @@ public function getAccounts() /** * Sets accounts * - * @param TemplateResponseAccount[]|null $accounts an array of the Accounts that can use this Template + * @param \Dropbox\Sign\Model\TemplateResponseAccount[]|null $accounts An array of the Accounts that can use this Template. * * @return self */ - public function setAccounts(?array $accounts) + public function setAccounts($accounts) { if (is_null($accounts)) { - throw new InvalidArgumentException('non-nullable accounts cannot be null'); + throw new \InvalidArgumentException('non-nullable accounts cannot be null'); } $this->container['accounts'] = $accounts; @@ -834,7 +848,7 @@ public function setAccounts(?array $accounts) /** * Gets attachments * - * @return SignatureRequestResponseAttachment[]|null + * @return \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null */ public function getAttachments() { @@ -844,26 +858,27 @@ public function getAttachments() /** * Sets attachments * - * @param SignatureRequestResponseAttachment[]|null $attachments signer attachments + * @param \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null $attachments Signer attachments. * * @return self */ - public function setAttachments(?array $attachments) + public function setAttachments($attachments) { if (is_null($attachments)) { - throw new InvalidArgumentException('non-nullable attachments cannot be null'); + throw new \InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -872,11 +887,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -887,8 +902,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -901,9 +918,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -911,15 +930,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -945,3 +964,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseAccount.php b/sdks/php/src/Model/TemplateResponseAccount.php index 47ddefabe..9d331d64b 100644 --- a/sdks/php/src/Model/TemplateResponseAccount.php +++ b/sdks/php/src/Model/TemplateResponseAccount.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,79 +29,78 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseAccount Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseAccount implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseAccount'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', 'is_locked' => 'bool', 'is_paid_hs' => 'bool', 'is_paid_hf' => 'bool', - 'quotas' => '\Dropbox\Sign\Model\TemplateResponseAccountQuota', + 'quotas' => '\Dropbox\Sign\Model\TemplateResponseAccountQuota' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => null, 'is_locked' => null, 'is_paid_hs' => null, 'is_paid_hf' => null, - 'quotas' => null, + 'quotas' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, 'is_locked' => false, 'is_paid_hs' => false, 'is_paid_hf' => false, - 'quotas' => false, + 'quotas' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -124,6 +125,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -133,7 +136,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -143,7 +146,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -152,6 +155,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -160,6 +166,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -178,7 +187,7 @@ public function isNullableSetToNull(string $property): bool 'is_locked' => 'is_locked', 'is_paid_hs' => 'is_paid_hs', 'is_paid_hf' => 'is_paid_hf', - 'quotas' => 'quotas', + 'quotas' => 'quotas' ]; /** @@ -192,7 +201,7 @@ public function isNullableSetToNull(string $property): bool 'is_locked' => 'setIsLocked', 'is_paid_hs' => 'setIsPaidHs', 'is_paid_hf' => 'setIsPaidHf', - 'quotas' => 'setQuotas', + 'quotas' => 'setQuotas' ]; /** @@ -206,7 +215,7 @@ public function isNullableSetToNull(string $property): bool 'is_locked' => 'getIsLocked', 'is_paid_hs' => 'getIsPaidHs', 'is_paid_hf' => 'getIsPaidHf', - 'quotas' => 'getQuotas', + 'quotas' => 'getQuotas' ]; /** @@ -250,6 +259,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -273,33 +283,34 @@ public function __construct(array $data = null) $this->setIfExists('quotas', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseAccount { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseAccount { /** @var TemplateResponseAccount */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseAccount::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -316,7 +327,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -330,6 +343,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets account_id * @@ -343,14 +357,14 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id the id of the Account + * @param string|null $account_id The id of the Account. * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId($account_id) { if (is_null($account_id)) { - throw new InvalidArgumentException('non-nullable account_id cannot be null'); + throw new \InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -370,14 +384,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address the email address associated with the Account + * @param string|null $email_address The email address associated with the Account. * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress($email_address) { if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -397,14 +411,14 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool|null $is_locked returns `true` if the user has been locked out of their account by a team admin + * @param bool|null $is_locked Returns `true` if the user has been locked out of their account by a team admin. * * @return self */ - public function setIsLocked(?bool $is_locked) + public function setIsLocked($is_locked) { if (is_null($is_locked)) { - throw new InvalidArgumentException('non-nullable is_locked cannot be null'); + throw new \InvalidArgumentException('non-nullable is_locked cannot be null'); } $this->container['is_locked'] = $is_locked; @@ -424,14 +438,14 @@ public function getIsPaidHs() /** * Sets is_paid_hs * - * @param bool|null $is_paid_hs returns `true` if the user has a paid Dropbox Sign account + * @param bool|null $is_paid_hs Returns `true` if the user has a paid Dropbox Sign account. * * @return self */ - public function setIsPaidHs(?bool $is_paid_hs) + public function setIsPaidHs($is_paid_hs) { if (is_null($is_paid_hs)) { - throw new InvalidArgumentException('non-nullable is_paid_hs cannot be null'); + throw new \InvalidArgumentException('non-nullable is_paid_hs cannot be null'); } $this->container['is_paid_hs'] = $is_paid_hs; @@ -451,14 +465,14 @@ public function getIsPaidHf() /** * Sets is_paid_hf * - * @param bool|null $is_paid_hf returns `true` if the user has a paid HelloFax account + * @param bool|null $is_paid_hf Returns `true` if the user has a paid HelloFax account. * * @return self */ - public function setIsPaidHf(?bool $is_paid_hf) + public function setIsPaidHf($is_paid_hf) { if (is_null($is_paid_hf)) { - throw new InvalidArgumentException('non-nullable is_paid_hf cannot be null'); + throw new \InvalidArgumentException('non-nullable is_paid_hf cannot be null'); } $this->container['is_paid_hf'] = $is_paid_hf; @@ -468,7 +482,7 @@ public function setIsPaidHf(?bool $is_paid_hf) /** * Gets quotas * - * @return TemplateResponseAccountQuota|null + * @return \Dropbox\Sign\Model\TemplateResponseAccountQuota|null */ public function getQuotas() { @@ -478,26 +492,27 @@ public function getQuotas() /** * Sets quotas * - * @param TemplateResponseAccountQuota|null $quotas quotas + * @param \Dropbox\Sign\Model\TemplateResponseAccountQuota|null $quotas quotas * * @return self */ - public function setQuotas(?TemplateResponseAccountQuota $quotas) + public function setQuotas($quotas) { if (is_null($quotas)) { - throw new InvalidArgumentException('non-nullable quotas cannot be null'); + throw new \InvalidArgumentException('non-nullable quotas cannot be null'); } $this->container['quotas'] = $quotas; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -506,11 +521,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -521,8 +536,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -535,9 +552,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -545,15 +564,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -579,3 +598,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseAccountQuota.php b/sdks/php/src/Model/TemplateResponseAccountQuota.php index 46386d6ec..bd3ebdbe5 100644 --- a/sdks/php/src/Model/TemplateResponseAccountQuota.php +++ b/sdks/php/src/Model/TemplateResponseAccountQuota.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,74 +29,73 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseAccountQuota Class Doc Comment * * @category Class * @description An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseAccountQuota implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseAccountQuota implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseAccountQuota'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'templates_left' => 'int', 'api_signature_requests_left' => 'int', 'documents_left' => 'int', - 'sms_verifications_left' => 'int', + 'sms_verifications_left' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'templates_left' => null, 'api_signature_requests_left' => null, 'documents_left' => null, - 'sms_verifications_left' => null, + 'sms_verifications_left' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'templates_left' => false, 'api_signature_requests_left' => false, 'documents_left' => false, - 'sms_verifications_left' => false, + 'sms_verifications_left' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,6 +120,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -128,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -138,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -147,6 +150,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -155,6 +161,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool 'templates_left' => 'templates_left', 'api_signature_requests_left' => 'api_signature_requests_left', 'documents_left' => 'documents_left', - 'sms_verifications_left' => 'sms_verifications_left', + 'sms_verifications_left' => 'sms_verifications_left' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'templates_left' => 'setTemplatesLeft', 'api_signature_requests_left' => 'setApiSignatureRequestsLeft', 'documents_left' => 'setDocumentsLeft', - 'sms_verifications_left' => 'setSmsVerificationsLeft', + 'sms_verifications_left' => 'setSmsVerificationsLeft' ]; /** @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'templates_left' => 'getTemplatesLeft', 'api_signature_requests_left' => 'getApiSignatureRequestsLeft', 'documents_left' => 'getDocumentsLeft', - 'sms_verifications_left' => 'getSmsVerificationsLeft', + 'sms_verifications_left' => 'getSmsVerificationsLeft' ]; /** @@ -239,6 +248,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -260,33 +270,34 @@ public function __construct(array $data = null) $this->setIfExists('sms_verifications_left', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseAccountQuota { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseAccountQuota { /** @var TemplateResponseAccountQuota */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseAccountQuota::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -303,7 +314,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -317,6 +330,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets templates_left * @@ -330,14 +344,14 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int|null $templates_left API templates remaining + * @param int|null $templates_left API templates remaining. * * @return self */ - public function setTemplatesLeft(?int $templates_left) + public function setTemplatesLeft($templates_left) { if (is_null($templates_left)) { - throw new InvalidArgumentException('non-nullable templates_left cannot be null'); + throw new \InvalidArgumentException('non-nullable templates_left cannot be null'); } $this->container['templates_left'] = $templates_left; @@ -357,14 +371,14 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int|null $api_signature_requests_left API signature requests remaining + * @param int|null $api_signature_requests_left API signature requests remaining. * * @return self */ - public function setApiSignatureRequestsLeft(?int $api_signature_requests_left) + public function setApiSignatureRequestsLeft($api_signature_requests_left) { if (is_null($api_signature_requests_left)) { - throw new InvalidArgumentException('non-nullable api_signature_requests_left cannot be null'); + throw new \InvalidArgumentException('non-nullable api_signature_requests_left cannot be null'); } $this->container['api_signature_requests_left'] = $api_signature_requests_left; @@ -384,14 +398,14 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int|null $documents_left signature requests remaining + * @param int|null $documents_left Signature requests remaining. * * @return self */ - public function setDocumentsLeft(?int $documents_left) + public function setDocumentsLeft($documents_left) { if (is_null($documents_left)) { - throw new InvalidArgumentException('non-nullable documents_left cannot be null'); + throw new \InvalidArgumentException('non-nullable documents_left cannot be null'); } $this->container['documents_left'] = $documents_left; @@ -411,26 +425,27 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int|null $sms_verifications_left SMS verifications remaining + * @param int|null $sms_verifications_left SMS verifications remaining. * * @return self */ - public function setSmsVerificationsLeft(?int $sms_verifications_left) + public function setSmsVerificationsLeft($sms_verifications_left) { if (is_null($sms_verifications_left)) { - throw new InvalidArgumentException('non-nullable sms_verifications_left cannot be null'); + throw new \InvalidArgumentException('non-nullable sms_verifications_left cannot be null'); } $this->container['sms_verifications_left'] = $sms_verifications_left; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -439,11 +454,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -454,8 +469,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -468,9 +485,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -478,15 +497,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -512,3 +531,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseCCRole.php b/sdks/php/src/Model/TemplateResponseCCRole.php index 06ee33219..607b73a23 100644 --- a/sdks/php/src/Model/TemplateResponseCCRole.php +++ b/sdks/php/src/Model/TemplateResponseCCRole.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseCCRole Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseCCRole implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseCCRole implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseCCRole'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'name' => 'string', + 'name' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'name' => null, + 'name' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'name' => false, + 'name' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'name' => 'name', + 'name' => 'name' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'name' => 'setName', + 'name' => 'setName' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'name' => 'getName', + 'name' => 'getName' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseCCRole { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseCCRole { /** @var TemplateResponseCCRole */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseCCRole::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -281,7 +292,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -295,6 +308,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -308,26 +322,27 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Role + * @param string|null $name The name of the Role. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -336,11 +351,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -351,8 +366,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -365,9 +382,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -375,15 +394,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -409,3 +428,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocument.php b/sdks/php/src/Model/TemplateResponseDocument.php index 02a88387d..2c1b4beee 100644 --- a/sdks/php/src/Model/TemplateResponseDocument.php +++ b/sdks/php/src/Model/TemplateResponseDocument.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,79 +29,78 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocument Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseDocument implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocument'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', 'index' => 'int', 'field_groups' => '\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]', 'form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', - 'static_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]', + 'static_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, 'index' => null, 'field_groups' => null, 'form_fields' => null, 'custom_fields' => null, - 'static_fields' => null, + 'static_fields' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'name' => false, 'index' => false, 'field_groups' => false, 'form_fields' => false, 'custom_fields' => false, - 'static_fields' => false, + 'static_fields' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -124,6 +125,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -133,7 +136,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -143,7 +146,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -152,6 +155,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -160,6 +166,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -178,7 +187,7 @@ public function isNullableSetToNull(string $property): bool 'field_groups' => 'field_groups', 'form_fields' => 'form_fields', 'custom_fields' => 'custom_fields', - 'static_fields' => 'static_fields', + 'static_fields' => 'static_fields' ]; /** @@ -192,7 +201,7 @@ public function isNullableSetToNull(string $property): bool 'field_groups' => 'setFieldGroups', 'form_fields' => 'setFormFields', 'custom_fields' => 'setCustomFields', - 'static_fields' => 'setStaticFields', + 'static_fields' => 'setStaticFields' ]; /** @@ -206,7 +215,7 @@ public function isNullableSetToNull(string $property): bool 'field_groups' => 'getFieldGroups', 'form_fields' => 'getFormFields', 'custom_fields' => 'getCustomFields', - 'static_fields' => 'getStaticFields', + 'static_fields' => 'getStaticFields' ]; /** @@ -250,6 +259,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -273,33 +283,34 @@ public function __construct(array $data = null) $this->setIfExists('static_fields', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocument { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocument { /** @var TemplateResponseDocument */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocument::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -316,7 +327,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -330,6 +343,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -343,14 +357,14 @@ public function getName() /** * Sets name * - * @param string|null $name name of the associated file + * @param string|null $name Name of the associated file. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -370,14 +384,14 @@ public function getIndex() /** * Sets index * - * @param int|null $index document ordering, the lowest index is displayed first and the highest last (0-based indexing) + * @param int|null $index Document ordering, the lowest index is displayed first and the highest last (0-based indexing). * * @return self */ - public function setIndex(?int $index) + public function setIndex($index) { if (is_null($index)) { - throw new InvalidArgumentException('non-nullable index cannot be null'); + throw new \InvalidArgumentException('non-nullable index cannot be null'); } $this->container['index'] = $index; @@ -387,7 +401,7 @@ public function setIndex(?int $index) /** * Gets field_groups * - * @return TemplateResponseDocumentFieldGroup[]|null + * @return \Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]|null */ public function getFieldGroups() { @@ -397,14 +411,14 @@ public function getFieldGroups() /** * Sets field_groups * - * @param TemplateResponseDocumentFieldGroup[]|null $field_groups an array of Form Field Group objects + * @param \Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]|null $field_groups An array of Form Field Group objects. * * @return self */ - public function setFieldGroups(?array $field_groups) + public function setFieldGroups($field_groups) { if (is_null($field_groups)) { - throw new InvalidArgumentException('non-nullable field_groups cannot be null'); + throw new \InvalidArgumentException('non-nullable field_groups cannot be null'); } $this->container['field_groups'] = $field_groups; @@ -414,7 +428,7 @@ public function setFieldGroups(?array $field_groups) /** * Gets form_fields * - * @return TemplateResponseDocumentFormFieldBase[]|null + * @return \Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]|null */ public function getFormFields() { @@ -424,14 +438,14 @@ public function getFormFields() /** * Sets form_fields * - * @param TemplateResponseDocumentFormFieldBase[]|null $form_fields an array of Form Field objects containing the name and type of each named field + * @param \Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]|null $form_fields An array of Form Field objects containing the name and type of each named field. * * @return self */ - public function setFormFields(?array $form_fields) + public function setFormFields($form_fields) { if (is_null($form_fields)) { - throw new InvalidArgumentException('non-nullable form_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable form_fields cannot be null'); } $this->container['form_fields'] = $form_fields; @@ -441,7 +455,7 @@ public function setFormFields(?array $form_fields) /** * Gets custom_fields * - * @return TemplateResponseDocumentCustomFieldBase[]|null + * @return \Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]|null */ public function getCustomFields() { @@ -451,14 +465,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields an array of Form Field objects containing the name and type of each named field + * @param \Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]|null $custom_fields An array of Form Field objects containing the name and type of each named field. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -468,7 +482,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets static_fields * - * @return TemplateResponseDocumentStaticFieldBase[]|null + * @return \Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]|null */ public function getStaticFields() { @@ -478,26 +492,27 @@ public function getStaticFields() /** * Sets static_fields * - * @param TemplateResponseDocumentStaticFieldBase[]|null $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * @param \Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]|null $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. * * @return self */ - public function setStaticFields(?array $static_fields) + public function setStaticFields($static_fields) { if (is_null($static_fields)) { - throw new InvalidArgumentException('non-nullable static_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable static_fields cannot be null'); } $this->container['static_fields'] = $static_fields; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -506,11 +521,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -521,8 +536,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -535,9 +552,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -545,15 +564,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -579,3 +598,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php index 011502522..24a4a7e43 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentCustomFieldBase Class Doc Comment * * @category Class * @description An array of Form Field objects containing the name and type of each named field. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentCustomFieldBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'api_id' => 'string', @@ -67,16 +68,16 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc 'width' => 'int', 'height' => 'int', 'required' => 'bool', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'api_id' => null, @@ -87,14 +88,14 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc 'width' => null, 'height' => null, 'required' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'api_id' => false, @@ -105,14 +106,14 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc 'width' => false, 'height' => false, 'required' => false, - 'group' => true, + 'group' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -137,6 +138,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -146,7 +149,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -156,7 +159,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -165,6 +168,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -173,6 +179,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'width', 'height' => 'height', 'required' => 'required', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -213,7 +222,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'setWidth', 'height' => 'setHeight', 'required' => 'setRequired', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -231,7 +240,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'getWidth', 'height' => 'getHeight', 'required' => 'getRequired', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -275,6 +284,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -305,6 +315,7 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } + public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -322,12 +333,14 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -363,6 +376,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -380,10 +394,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -403,14 +417,14 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id the unique ID for this field + * @param string|null $api_id The unique ID for this field. * * @return self */ - public function setApiId(?string $api_id) + public function setApiId($api_id) { if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + throw new \InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -430,14 +444,14 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Custom Field + * @param string|null $name The name of the Custom Field. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -461,14 +475,14 @@ public function getSigner() * * @return self */ - public function setSigner(?string $signer) + public function setSigner($signer) { if (is_null($signer)) { array_push($this->openAPINullablesSetToNull, 'signer'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signer', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -491,14 +505,14 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this form field + * @param int|null $x The horizontal offset in pixels for this form field. * * @return self */ - public function setX(?int $x) + public function setX($x) { if (is_null($x)) { - throw new InvalidArgumentException('non-nullable x cannot be null'); + throw new \InvalidArgumentException('non-nullable x cannot be null'); } $this->container['x'] = $x; @@ -518,14 +532,14 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this form field + * @param int|null $y The vertical offset in pixels for this form field. * * @return self */ - public function setY(?int $y) + public function setY($y) { if (is_null($y)) { - throw new InvalidArgumentException('non-nullable y cannot be null'); + throw new \InvalidArgumentException('non-nullable y cannot be null'); } $this->container['y'] = $y; @@ -545,14 +559,14 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this form field + * @param int|null $width The width in pixels of this form field. * * @return self */ - public function setWidth(?int $width) + public function setWidth($width) { if (is_null($width)) { - throw new InvalidArgumentException('non-nullable width cannot be null'); + throw new \InvalidArgumentException('non-nullable width cannot be null'); } $this->container['width'] = $width; @@ -572,14 +586,14 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this form field + * @param int|null $height The height in pixels of this form field. * * @return self */ - public function setHeight(?int $height) + public function setHeight($height) { if (is_null($height)) { - throw new InvalidArgumentException('non-nullable height cannot be null'); + throw new \InvalidArgumentException('non-nullable height cannot be null'); } $this->container['height'] = $height; @@ -599,14 +613,14 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool|null $required Boolean showing whether or not this field is required. * * @return self */ - public function setRequired(?bool $required) + public function setRequired($required) { if (is_null($required)) { - throw new InvalidArgumentException('non-nullable required cannot be null'); + throw new \InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -630,14 +644,14 @@ public function getGroup() * * @return self */ - public function setGroup(?string $group) + public function setGroup($group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -646,13 +660,14 @@ public function setGroup(?string $group) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -661,11 +676,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -676,8 +691,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -690,9 +707,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -700,15 +719,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -734,3 +753,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php index 7ec8dc018..4b4143270 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentCustomFieldCheckbox Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentCustomFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentCustomFieldCheckbox extends TemplateResponseDocumentCustomFieldBase @@ -44,46 +45,46 @@ class TemplateResponseDocumentCustomFieldCheckbox extends TemplateResponseDocume public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentCustomFieldCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'checkbox'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentCustomFieldCheckbox { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentCustomFieldCheckbox { /** @var TemplateResponseDocumentCustomFieldCheckbox */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentCustomFieldCheckbox::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php index e63a73978..adef7398a 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentCustomFieldText Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentCustomFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentCustomFieldText extends TemplateResponseDocumentCustomFieldBase @@ -44,58 +45,58 @@ class TemplateResponseDocumentCustomFieldText extends TemplateResponseDocumentCu public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentCustomFieldText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'avg_text_length' => '\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength', 'is_multiline' => 'bool', 'original_font_size' => 'int', - 'font_family' => 'string', + 'font_family' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'avg_text_length' => null, 'is_multiline' => null, 'original_font_size' => null, - 'font_family' => null, + 'font_family' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'avg_text_length' => false, 'is_multiline' => false, 'original_font_size' => false, - 'font_family' => false, + 'font_family' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,6 +121,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -129,7 +132,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -139,7 +142,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -148,6 +151,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -156,6 +162,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'avg_text_length' => 'avg_text_length', 'is_multiline' => 'isMultiline', 'original_font_size' => 'originalFontSize', - 'font_family' => 'fontFamily', + 'font_family' => 'fontFamily' ]; /** @@ -186,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'avg_text_length' => 'setAvgTextLength', 'is_multiline' => 'setIsMultiline', 'original_font_size' => 'setOriginalFontSize', - 'font_family' => 'setFontFamily', + 'font_family' => 'setFontFamily' ]; /** @@ -199,7 +208,7 @@ public function isNullableSetToNull(string $property): bool 'avg_text_length' => 'getAvgTextLength', 'is_multiline' => 'getIsMultiline', 'original_font_size' => 'getOriginalFontSize', - 'font_family' => 'getFontFamily', + 'font_family' => 'getFontFamily' ]; /** @@ -243,6 +252,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -260,33 +271,34 @@ public function __construct(array $data = null) $this->setIfExists('font_family', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentCustomFieldText { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentCustomFieldText { /** @var TemplateResponseDocumentCustomFieldText */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentCustomFieldText::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -322,6 +334,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -339,10 +352,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -352,7 +365,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength|null + * @return \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null */ public function getAvgTextLength() { @@ -362,14 +375,14 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength($avg_text_length) { if (is_null($avg_text_length)) { - throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); + throw new \InvalidArgumentException('non-nullable avg_text_length cannot be null'); } $this->container['avg_text_length'] = $avg_text_length; @@ -389,14 +402,14 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool|null $is_multiline Whether this form field is multiline text. * * @return self */ - public function setIsMultiline(?bool $is_multiline) + public function setIsMultiline($is_multiline) { if (is_null($is_multiline)) { - throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); + throw new \InvalidArgumentException('non-nullable is_multiline cannot be null'); } $this->container['is_multiline'] = $is_multiline; @@ -416,14 +429,14 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int|null $original_font_size Original font size used in this form field's text. * * @return self */ - public function setOriginalFontSize(?int $original_font_size) + public function setOriginalFontSize($original_font_size) { if (is_null($original_font_size)) { - throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); + throw new \InvalidArgumentException('non-nullable original_font_size cannot be null'); } $this->container['original_font_size'] = $original_font_size; @@ -443,26 +456,27 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string|null $font_family Font family used in this form field's text. * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily($font_family) { if (is_null($font_family)) { - throw new InvalidArgumentException('non-nullable font_family cannot be null'); + throw new \InvalidArgumentException('non-nullable font_family cannot be null'); } $this->container['font_family'] = $font_family; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -471,11 +485,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -486,8 +500,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -500,9 +516,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -510,15 +528,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -544,3 +562,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php index 541714841..cb478b40e 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFieldGroup Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocumentFieldGroup implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseDocumentFieldGroup implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFieldGroup'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', - 'rule' => '\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule', + 'rule' => '\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, - 'rule' => null, + 'rule' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'name' => false, - 'rule' => false, + 'rule' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'rule' => 'rule', + 'rule' => 'rule' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'rule' => 'setRule', + 'rule' => 'setRule' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'rule' => 'getRule', + 'rule' => 'getRule' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('rule', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentFieldGroup { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentFieldGroup { /** @var TemplateResponseDocumentFieldGroup */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentFieldGroup::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -288,7 +299,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -302,6 +315,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -315,14 +329,14 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the form field group + * @param string|null $name The name of the form field group. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -332,7 +346,7 @@ public function setName(?string $name) /** * Gets rule * - * @return TemplateResponseDocumentFieldGroupRule|null + * @return \Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule|null */ public function getRule() { @@ -342,26 +356,27 @@ public function getRule() /** * Sets rule * - * @param TemplateResponseDocumentFieldGroupRule|null $rule rule + * @param \Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule|null $rule rule * * @return self */ - public function setRule(?TemplateResponseDocumentFieldGroupRule $rule) + public function setRule($rule) { if (is_null($rule)) { - throw new InvalidArgumentException('non-nullable rule cannot be null'); + throw new \InvalidArgumentException('non-nullable rule cannot be null'); } $this->container['rule'] = $rule; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -370,11 +385,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -385,8 +400,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -399,9 +416,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -409,15 +428,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -443,3 +462,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php index 1bd31bde9..c217baeee 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,68 +29,67 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFieldGroupRule Class Doc Comment * * @category Class * @description The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocumentFieldGroupRule implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseDocumentFieldGroupRule implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFieldGroupRule'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'requirement' => 'string', - 'group_label' => 'string', + 'group_label' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'requirement' => null, - 'group_label' => null, + 'group_label' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'requirement' => false, - 'group_label' => false, + 'group_label' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -163,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'requirement' => 'requirement', - 'group_label' => 'groupLabel', + 'group_label' => 'groupLabel' ]; /** @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'requirement' => 'setRequirement', - 'group_label' => 'setGroupLabel', + 'group_label' => 'setGroupLabel' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'requirement' => 'getRequirement', - 'group_label' => 'getGroupLabel', + 'group_label' => 'getGroupLabel' ]; /** @@ -227,6 +236,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -246,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('group_label', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentFieldGroupRule { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentFieldGroupRule { /** @var TemplateResponseDocumentFieldGroupRule */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentFieldGroupRule::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -289,7 +300,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -303,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets requirement * @@ -320,10 +334,10 @@ public function getRequirement() * * @return self */ - public function setRequirement(?string $requirement) + public function setRequirement($requirement) { if (is_null($requirement)) { - throw new InvalidArgumentException('non-nullable requirement cannot be null'); + throw new \InvalidArgumentException('non-nullable requirement cannot be null'); } $this->container['requirement'] = $requirement; @@ -347,22 +361,23 @@ public function getGroupLabel() * * @return self */ - public function setGroupLabel(?string $group_label) + public function setGroupLabel($group_label) { if (is_null($group_label)) { - throw new InvalidArgumentException('non-nullable group_label cannot be null'); + throw new \InvalidArgumentException('non-nullable group_label cannot be null'); } $this->container['group_label'] = $group_label; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -371,11 +386,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -386,8 +401,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -400,9 +417,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -410,15 +429,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -444,3 +463,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php index ecc03a7db..ce6910ba5 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFormFieldBase Class Doc Comment * * @category Class * @description An array of Form Field objects containing the name and type of each named field. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'api_id' => 'string', @@ -66,16 +67,16 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce 'y' => 'int', 'width' => 'int', 'height' => 'int', - 'required' => 'bool', + 'required' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'api_id' => null, @@ -85,14 +86,14 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce 'y' => null, 'width' => null, 'height' => null, - 'required' => null, + 'required' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'api_id' => false, @@ -102,14 +103,14 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce 'y' => false, 'width' => false, 'height' => false, - 'required' => false, + 'required' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -134,6 +135,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -143,7 +146,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -153,7 +156,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -162,6 +165,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -170,6 +176,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -191,7 +200,7 @@ public function isNullableSetToNull(string $property): bool 'y' => 'y', 'width' => 'width', 'height' => 'height', - 'required' => 'required', + 'required' => 'required' ]; /** @@ -208,7 +217,7 @@ public function isNullableSetToNull(string $property): bool 'y' => 'setY', 'width' => 'setWidth', 'height' => 'setHeight', - 'required' => 'setRequired', + 'required' => 'setRequired' ]; /** @@ -225,7 +234,7 @@ public function isNullableSetToNull(string $property): bool 'y' => 'getY', 'width' => 'getWidth', 'height' => 'getHeight', - 'required' => 'getRequired', + 'required' => 'getRequired' ]; /** @@ -269,6 +278,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -298,6 +308,7 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } + public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -333,12 +344,14 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -374,6 +387,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -391,10 +405,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -414,14 +428,14 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id a unique id for the form field + * @param string|null $api_id A unique id for the form field. * * @return self */ - public function setApiId(?string $api_id) + public function setApiId($api_id) { if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + throw new \InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -441,14 +455,14 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the form field + * @param string|null $name The name of the form field. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -468,14 +482,14 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer the signer of the Form Field + * @param string|null $signer The signer of the Form Field. * * @return self */ - public function setSigner(?string $signer) + public function setSigner($signer) { if (is_null($signer)) { - throw new InvalidArgumentException('non-nullable signer cannot be null'); + throw new \InvalidArgumentException('non-nullable signer cannot be null'); } $this->container['signer'] = $signer; @@ -495,14 +509,14 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this form field + * @param int|null $x The horizontal offset in pixels for this form field. * * @return self */ - public function setX(?int $x) + public function setX($x) { if (is_null($x)) { - throw new InvalidArgumentException('non-nullable x cannot be null'); + throw new \InvalidArgumentException('non-nullable x cannot be null'); } $this->container['x'] = $x; @@ -522,14 +536,14 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this form field + * @param int|null $y The vertical offset in pixels for this form field. * * @return self */ - public function setY(?int $y) + public function setY($y) { if (is_null($y)) { - throw new InvalidArgumentException('non-nullable y cannot be null'); + throw new \InvalidArgumentException('non-nullable y cannot be null'); } $this->container['y'] = $y; @@ -549,14 +563,14 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this form field + * @param int|null $width The width in pixels of this form field. * * @return self */ - public function setWidth(?int $width) + public function setWidth($width) { if (is_null($width)) { - throw new InvalidArgumentException('non-nullable width cannot be null'); + throw new \InvalidArgumentException('non-nullable width cannot be null'); } $this->container['width'] = $width; @@ -576,14 +590,14 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this form field + * @param int|null $height The height in pixels of this form field. * * @return self */ - public function setHeight(?int $height) + public function setHeight($height) { if (is_null($height)) { - throw new InvalidArgumentException('non-nullable height cannot be null'); + throw new \InvalidArgumentException('non-nullable height cannot be null'); } $this->container['height'] = $height; @@ -603,26 +617,27 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool|null $required Boolean showing whether or not this field is required. * * @return self */ - public function setRequired(?bool $required) + public function setRequired($required) { if (is_null($required)) { - throw new InvalidArgumentException('non-nullable required cannot be null'); + throw new \InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -631,11 +646,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -646,8 +661,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -660,9 +677,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -670,15 +689,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -704,3 +723,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php index a30010fc1..5ef9aafc1 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFormFieldCheckbox Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocumentFormFieldBase @@ -44,49 +45,49 @@ class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocument public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => true, + 'group' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,6 +112,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -120,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,6 +142,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -147,6 +153,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -161,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -181,7 +190,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -225,6 +234,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -239,33 +250,34 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldCheckbox { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentFormFieldCheckbox { /** @var TemplateResponseDocumentFormFieldCheckbox */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldCheckbox::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -301,6 +313,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -318,10 +331,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -345,14 +358,14 @@ public function getGroup() * * @return self */ - public function setGroup(?string $group) + public function setGroup($group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -361,13 +374,14 @@ public function setGroup(?string $group) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -376,11 +390,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -391,8 +405,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -405,9 +421,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -415,15 +433,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -449,3 +467,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php index bd6072350..b3c0c7c5e 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFormFieldDateSigned Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocumentFormFieldBase @@ -44,49 +45,49 @@ class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocume public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldDateSigned'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => true, + 'group' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,6 +112,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -120,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,6 +142,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -147,6 +153,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -161,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -181,7 +190,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -225,6 +234,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -239,33 +250,34 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldDateSigned { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentFormFieldDateSigned { /** @var TemplateResponseDocumentFormFieldDateSigned */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldDateSigned::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -301,6 +313,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -318,10 +331,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -345,14 +358,14 @@ public function getGroup() * * @return self */ - public function setGroup(?string $group) + public function setGroup($group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -361,13 +374,14 @@ public function setGroup(?string $group) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -376,11 +390,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -391,8 +405,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -405,9 +421,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -415,15 +433,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -449,3 +467,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php index 3e4a827da..3e04ad34f 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFormFieldDropdown Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocumentFormFieldBase @@ -44,49 +45,49 @@ class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocument public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldDropdown'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => true, + 'group' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,6 +112,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -120,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,6 +142,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -147,6 +153,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -161,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -181,7 +190,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -225,6 +234,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -239,33 +250,34 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldDropdown { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentFormFieldDropdown { /** @var TemplateResponseDocumentFormFieldDropdown */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldDropdown::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -301,6 +313,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -318,10 +331,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -345,14 +358,14 @@ public function getGroup() * * @return self */ - public function setGroup(?string $group) + public function setGroup($group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -361,13 +374,14 @@ public function setGroup(?string $group) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -376,11 +390,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -391,8 +405,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -405,9 +421,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -415,15 +433,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -449,3 +467,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php index 687269f79..38ab2d6db 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFormFieldHyperlink Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumentFormFieldBase @@ -44,61 +45,61 @@ class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumen public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldHyperlink'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'avg_text_length' => '\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength', 'is_multiline' => 'bool', 'original_font_size' => 'int', 'font_family' => 'string', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'avg_text_length' => null, 'is_multiline' => null, 'original_font_size' => null, 'font_family' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'avg_text_length' => false, 'is_multiline' => false, 'original_font_size' => false, 'font_family' => false, - 'group' => true, + 'group' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -123,6 +124,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -132,7 +135,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -142,7 +145,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -151,6 +154,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -159,6 +165,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -177,7 +186,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'isMultiline', 'original_font_size' => 'originalFontSize', 'font_family' => 'fontFamily', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -191,7 +200,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'setIsMultiline', 'original_font_size' => 'setOriginalFontSize', 'font_family' => 'setFontFamily', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -205,7 +214,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'getIsMultiline', 'original_font_size' => 'getOriginalFontSize', 'font_family' => 'getFontFamily', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -249,6 +258,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -267,33 +278,34 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldHyperlink { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentFormFieldHyperlink { /** @var TemplateResponseDocumentFormFieldHyperlink */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldHyperlink::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -329,6 +341,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -346,10 +359,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -359,7 +372,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength|null + * @return \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null */ public function getAvgTextLength() { @@ -369,14 +382,14 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength($avg_text_length) { if (is_null($avg_text_length)) { - throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); + throw new \InvalidArgumentException('non-nullable avg_text_length cannot be null'); } $this->container['avg_text_length'] = $avg_text_length; @@ -396,14 +409,14 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool|null $is_multiline Whether this form field is multiline text. * * @return self */ - public function setIsMultiline(?bool $is_multiline) + public function setIsMultiline($is_multiline) { if (is_null($is_multiline)) { - throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); + throw new \InvalidArgumentException('non-nullable is_multiline cannot be null'); } $this->container['is_multiline'] = $is_multiline; @@ -423,14 +436,14 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int|null $original_font_size Original font size used in this form field's text. * * @return self */ - public function setOriginalFontSize(?int $original_font_size) + public function setOriginalFontSize($original_font_size) { if (is_null($original_font_size)) { - throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); + throw new \InvalidArgumentException('non-nullable original_font_size cannot be null'); } $this->container['original_font_size'] = $original_font_size; @@ -450,14 +463,14 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string|null $font_family Font family used in this form field's text. * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily($font_family) { if (is_null($font_family)) { - throw new InvalidArgumentException('non-nullable font_family cannot be null'); + throw new \InvalidArgumentException('non-nullable font_family cannot be null'); } $this->container['font_family'] = $font_family; @@ -481,14 +494,14 @@ public function getGroup() * * @return self */ - public function setGroup(?string $group) + public function setGroup($group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -497,13 +510,14 @@ public function setGroup(?string $group) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -512,11 +526,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -527,8 +541,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -541,9 +557,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -551,15 +569,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -585,3 +603,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php index 101a6e955..207f3564a 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFormFieldInitials Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocumentFormFieldBase @@ -44,49 +45,49 @@ class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocument public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldInitials'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => true, + 'group' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,6 +112,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -120,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,6 +142,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -147,6 +153,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -161,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -181,7 +190,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -225,6 +234,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -239,33 +250,34 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldInitials { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentFormFieldInitials { /** @var TemplateResponseDocumentFormFieldInitials */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldInitials::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -301,6 +313,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -318,10 +331,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -345,14 +358,14 @@ public function getGroup() * * @return self */ - public function setGroup(?string $group) + public function setGroup($group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -361,13 +374,14 @@ public function setGroup(?string $group) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -376,11 +390,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -391,8 +405,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -405,9 +421,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -415,15 +433,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -449,3 +467,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php index 8fd494678..cd5a776ce 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFormFieldRadio Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFormFieldBase @@ -44,49 +45,49 @@ class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFor public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldRadio'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => false, + 'group' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,6 +112,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -120,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,6 +142,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -147,6 +153,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -161,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -181,7 +190,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -225,6 +234,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -239,33 +250,34 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldRadio { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentFormFieldRadio { /** @var TemplateResponseDocumentFormFieldRadio */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldRadio::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -304,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -321,10 +334,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -348,22 +361,23 @@ public function getGroup() * * @return self */ - public function setGroup(string $group) + public function setGroup($group) { if (is_null($group)) { - throw new InvalidArgumentException('non-nullable group cannot be null'); + throw new \InvalidArgumentException('non-nullable group cannot be null'); } $this->container['group'] = $group; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -372,11 +386,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -387,8 +401,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -401,9 +417,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -411,15 +429,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -445,3 +463,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php index 777777464..98bd3a199 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFormFieldSignature Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumentFormFieldBase @@ -44,49 +45,49 @@ class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumen public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldSignature'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => true, + 'group' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,6 +112,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -120,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,6 +142,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -147,6 +153,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -161,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -171,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -181,7 +190,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -225,6 +234,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -239,33 +250,34 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldSignature { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentFormFieldSignature { /** @var TemplateResponseDocumentFormFieldSignature */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldSignature::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -301,6 +313,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -318,10 +331,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -345,14 +358,14 @@ public function getGroup() * * @return self */ - public function setGroup(?string $group) + public function setGroup($group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -361,13 +374,14 @@ public function setGroup(?string $group) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -376,11 +390,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -391,8 +405,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -405,9 +421,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -415,15 +433,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -449,3 +467,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php index 42c15b9ed..50566ad74 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentFormFieldText Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentFormFieldBase @@ -44,17 +45,17 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'avg_text_length' => '\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength', @@ -62,16 +63,16 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => 'int', 'font_family' => 'string', 'validation_type' => 'string', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'avg_text_length' => null, @@ -79,14 +80,14 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => null, 'font_family' => null, 'validation_type' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'avg_text_length' => false, @@ -94,14 +95,14 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => false, 'font_family' => false, 'validation_type' => true, - 'group' => true, + 'group' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -126,6 +127,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -135,7 +138,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -145,7 +148,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -154,6 +157,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -162,6 +168,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -181,7 +190,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'originalFontSize', 'font_family' => 'fontFamily', 'validation_type' => 'validation_type', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -196,7 +205,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'setOriginalFontSize', 'font_family' => 'setFontFamily', 'validation_type' => 'setValidationType', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -211,7 +220,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'getOriginalFontSize', 'font_family' => 'getFontFamily', 'validation_type' => 'getValidationType', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -287,6 +296,7 @@ public function getValidationTypeAllowableValues() ]; } + /** * Constructor * @@ -306,33 +316,34 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldText { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentFormFieldText { /** @var TemplateResponseDocumentFormFieldText */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldText::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -377,6 +388,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -394,10 +406,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -407,7 +419,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength|null + * @return \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null */ public function getAvgTextLength() { @@ -417,14 +429,14 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength($avg_text_length) { if (is_null($avg_text_length)) { - throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); + throw new \InvalidArgumentException('non-nullable avg_text_length cannot be null'); } $this->container['avg_text_length'] = $avg_text_length; @@ -444,14 +456,14 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool|null $is_multiline Whether this form field is multiline text. * * @return self */ - public function setIsMultiline(?bool $is_multiline) + public function setIsMultiline($is_multiline) { if (is_null($is_multiline)) { - throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); + throw new \InvalidArgumentException('non-nullable is_multiline cannot be null'); } $this->container['is_multiline'] = $is_multiline; @@ -471,14 +483,14 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int|null $original_font_size Original font size used in this form field's text. * * @return self */ - public function setOriginalFontSize(?int $original_font_size) + public function setOriginalFontSize($original_font_size) { if (is_null($original_font_size)) { - throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); + throw new \InvalidArgumentException('non-nullable original_font_size cannot be null'); } $this->container['original_font_size'] = $original_font_size; @@ -498,14 +510,14 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string|null $font_family Font family used in this form field's text. * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily($font_family) { if (is_null($font_family)) { - throw new InvalidArgumentException('non-nullable font_family cannot be null'); + throw new \InvalidArgumentException('non-nullable font_family cannot be null'); } $this->container['font_family'] = $font_family; @@ -529,21 +541,21 @@ public function getValidationType() * * @return self */ - public function setValidationType(?string $validation_type) + public function setValidationType($validation_type) { if (is_null($validation_type)) { array_push($this->openAPINullablesSetToNull, 'validation_type'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('validation_type', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } } $allowedValues = $this->getValidationTypeAllowableValues(); if (!is_null($validation_type) && !in_array($validation_type, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'validation_type', must be one of '%s'", $validation_type, @@ -573,14 +585,14 @@ public function getGroup() * * @return self */ - public function setGroup(?string $group) + public function setGroup($group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -589,13 +601,14 @@ public function setGroup(?string $group) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -604,11 +617,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -619,8 +632,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -633,9 +648,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -643,15 +660,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -677,3 +694,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php index bd18e1847..6499e20b8 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentStaticFieldBase Class Doc Comment * * @category Class * @description An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'api_id' => 'string', @@ -67,16 +68,16 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc 'width' => 'int', 'height' => 'int', 'required' => 'bool', - 'group' => 'string', + 'group' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'api_id' => null, @@ -87,14 +88,14 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc 'width' => null, 'height' => null, 'required' => null, - 'group' => null, + 'group' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'api_id' => false, @@ -105,14 +106,14 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc 'width' => false, 'height' => false, 'required' => false, - 'group' => true, + 'group' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -137,6 +138,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -146,7 +149,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -156,7 +159,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -165,6 +168,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -173,6 +179,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -195,7 +204,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'width', 'height' => 'height', 'required' => 'required', - 'group' => 'group', + 'group' => 'group' ]; /** @@ -213,7 +222,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'setWidth', 'height' => 'setHeight', 'required' => 'setRequired', - 'group' => 'setGroup', + 'group' => 'setGroup' ]; /** @@ -231,7 +240,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'getWidth', 'height' => 'getHeight', 'required' => 'getRequired', - 'group' => 'getGroup', + 'group' => 'getGroup' ]; /** @@ -275,6 +284,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -305,6 +315,7 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } + public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -340,12 +351,14 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -381,6 +394,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -398,10 +412,10 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -421,14 +435,14 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id a unique id for the static field + * @param string|null $api_id A unique id for the static field. * * @return self */ - public function setApiId(?string $api_id) + public function setApiId($api_id) { if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + throw new \InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -448,14 +462,14 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the static field + * @param string|null $name The name of the static field. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -475,14 +489,14 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer the signer of the Static Field + * @param string|null $signer The signer of the Static Field. * * @return self */ - public function setSigner(?string $signer) + public function setSigner($signer) { if (is_null($signer)) { - throw new InvalidArgumentException('non-nullable signer cannot be null'); + throw new \InvalidArgumentException('non-nullable signer cannot be null'); } $this->container['signer'] = $signer; @@ -502,14 +516,14 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this static field + * @param int|null $x The horizontal offset in pixels for this static field. * * @return self */ - public function setX(?int $x) + public function setX($x) { if (is_null($x)) { - throw new InvalidArgumentException('non-nullable x cannot be null'); + throw new \InvalidArgumentException('non-nullable x cannot be null'); } $this->container['x'] = $x; @@ -529,14 +543,14 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this static field + * @param int|null $y The vertical offset in pixels for this static field. * * @return self */ - public function setY(?int $y) + public function setY($y) { if (is_null($y)) { - throw new InvalidArgumentException('non-nullable y cannot be null'); + throw new \InvalidArgumentException('non-nullable y cannot be null'); } $this->container['y'] = $y; @@ -556,14 +570,14 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this static field + * @param int|null $width The width in pixels of this static field. * * @return self */ - public function setWidth(?int $width) + public function setWidth($width) { if (is_null($width)) { - throw new InvalidArgumentException('non-nullable width cannot be null'); + throw new \InvalidArgumentException('non-nullable width cannot be null'); } $this->container['width'] = $width; @@ -583,14 +597,14 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this static field + * @param int|null $height The height in pixels of this static field. * * @return self */ - public function setHeight(?int $height) + public function setHeight($height) { if (is_null($height)) { - throw new InvalidArgumentException('non-nullable height cannot be null'); + throw new \InvalidArgumentException('non-nullable height cannot be null'); } $this->container['height'] = $height; @@ -610,14 +624,14 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool|null $required Boolean showing whether or not this field is required. * * @return self */ - public function setRequired(?bool $required) + public function setRequired($required) { if (is_null($required)) { - throw new InvalidArgumentException('non-nullable required cannot be null'); + throw new \InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -641,14 +655,14 @@ public function getGroup() * * @return self */ - public function setGroup(?string $group) + public function setGroup($group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -657,13 +671,14 @@ public function setGroup(?string $group) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -672,11 +687,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -687,8 +702,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -701,9 +718,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -711,15 +730,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -745,3 +764,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php index 9739d2e05..8cb4bd718 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentStaticFieldCheckbox Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldCheckbox extends TemplateResponseDocumentStaticFieldBase @@ -44,46 +45,46 @@ class TemplateResponseDocumentStaticFieldCheckbox extends TemplateResponseDocume public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'checkbox'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldCheckbox { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentStaticFieldCheckbox { /** @var TemplateResponseDocumentStaticFieldCheckbox */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldCheckbox::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php index 911febf8d..4806361ba 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentStaticFieldDateSigned Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldDateSigned extends TemplateResponseDocumentStaticFieldBase @@ -44,46 +45,46 @@ class TemplateResponseDocumentStaticFieldDateSigned extends TemplateResponseDocu public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldDateSigned'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'date_signed'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldDateSigned { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentStaticFieldDateSigned { /** @var TemplateResponseDocumentStaticFieldDateSigned */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldDateSigned::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php index 6022f9289..f0ca4abc2 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentStaticFieldDropdown Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldDropdown extends TemplateResponseDocumentStaticFieldBase @@ -44,46 +45,46 @@ class TemplateResponseDocumentStaticFieldDropdown extends TemplateResponseDocume public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldDropdown'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'dropdown'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldDropdown { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentStaticFieldDropdown { /** @var TemplateResponseDocumentStaticFieldDropdown */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldDropdown::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php index 246bea450..9d87a0c0f 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentStaticFieldHyperlink Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldHyperlink extends TemplateResponseDocumentStaticFieldBase @@ -44,46 +45,46 @@ class TemplateResponseDocumentStaticFieldHyperlink extends TemplateResponseDocum public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldHyperlink'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'hyperlink'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldHyperlink { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentStaticFieldHyperlink { /** @var TemplateResponseDocumentStaticFieldHyperlink */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldHyperlink::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php index 339b3a2a5..9925dd541 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentStaticFieldInitials Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldInitials extends TemplateResponseDocumentStaticFieldBase @@ -44,46 +45,46 @@ class TemplateResponseDocumentStaticFieldInitials extends TemplateResponseDocume public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldInitials'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'initials'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldInitials { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentStaticFieldInitials { /** @var TemplateResponseDocumentStaticFieldInitials */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldInitials::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php index 8dc139712..b109c83ce 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentStaticFieldRadio Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldRadio extends TemplateResponseDocumentStaticFieldBase @@ -44,46 +45,46 @@ class TemplateResponseDocumentStaticFieldRadio extends TemplateResponseDocumentS public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldRadio'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'radio'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldRadio { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentStaticFieldRadio { /** @var TemplateResponseDocumentStaticFieldRadio */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldRadio::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php index c86d1c9a3..8f6a1b815 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentStaticFieldSignature Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldSignature extends TemplateResponseDocumentStaticFieldBase @@ -44,46 +45,46 @@ class TemplateResponseDocumentStaticFieldSignature extends TemplateResponseDocum public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldSignature'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'signature'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldSignature { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentStaticFieldSignature { /** @var TemplateResponseDocumentStaticFieldSignature */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldSignature::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php index ec89541e3..538ad2312 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -26,17 +28,16 @@ */ namespace Dropbox\Sign\Model; - -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use ReturnTypeWillChange; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseDocumentStaticFieldText Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldText extends TemplateResponseDocumentStaticFieldBase @@ -44,46 +45,46 @@ class TemplateResponseDocumentStaticFieldText extends TemplateResponseDocumentSt public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string', + 'type' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null, + 'type' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'type' => false, + 'type' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -108,6 +109,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -117,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -127,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -136,6 +139,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -144,6 +150,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -157,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', + 'type' => 'type' ]; /** @@ -166,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', + 'type' => 'setType' ]; /** @@ -175,7 +184,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', + 'type' => 'getType' ]; /** @@ -219,6 +228,8 @@ public function getModelName() return self::$openAPIModelName; } + + /** * Constructor * @@ -232,33 +243,34 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'text'); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldText { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseDocumentStaticFieldText { /** @var TemplateResponseDocumentStaticFieldText */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldText::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -294,6 +306,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -311,22 +324,23 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -335,11 +349,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -350,8 +364,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -364,9 +380,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -374,15 +392,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -408,3 +426,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php index 9277db26a..60e811df9 100644 --- a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php +++ b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,68 +29,67 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseFieldAvgTextLength Class Doc Comment * * @category Class * @description Average text length in this field. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseFieldAvgTextLength implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseFieldAvgTextLength implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseFieldAvgTextLength'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'num_lines' => 'int', - 'num_chars_per_line' => 'int', + 'num_chars_per_line' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'num_lines' => null, - 'num_chars_per_line' => null, + 'num_chars_per_line' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'num_lines' => false, - 'num_chars_per_line' => false, + 'num_chars_per_line' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -163,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'num_lines' => 'num_lines', - 'num_chars_per_line' => 'num_chars_per_line', + 'num_chars_per_line' => 'num_chars_per_line' ]; /** @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'num_lines' => 'setNumLines', - 'num_chars_per_line' => 'setNumCharsPerLine', + 'num_chars_per_line' => 'setNumCharsPerLine' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'num_lines' => 'getNumLines', - 'num_chars_per_line' => 'getNumCharsPerLine', + 'num_chars_per_line' => 'getNumCharsPerLine' ]; /** @@ -227,6 +236,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -246,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('num_chars_per_line', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseFieldAvgTextLength { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseFieldAvgTextLength { /** @var TemplateResponseFieldAvgTextLength */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseFieldAvgTextLength::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -289,7 +300,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -303,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets num_lines * @@ -316,14 +330,14 @@ public function getNumLines() /** * Sets num_lines * - * @param int|null $num_lines number of lines + * @param int|null $num_lines Number of lines. * * @return self */ - public function setNumLines(?int $num_lines) + public function setNumLines($num_lines) { if (is_null($num_lines)) { - throw new InvalidArgumentException('non-nullable num_lines cannot be null'); + throw new \InvalidArgumentException('non-nullable num_lines cannot be null'); } $this->container['num_lines'] = $num_lines; @@ -343,26 +357,27 @@ public function getNumCharsPerLine() /** * Sets num_chars_per_line * - * @param int|null $num_chars_per_line number of characters per line + * @param int|null $num_chars_per_line Number of characters per line. * * @return self */ - public function setNumCharsPerLine(?int $num_chars_per_line) + public function setNumCharsPerLine($num_chars_per_line) { if (is_null($num_chars_per_line)) { - throw new InvalidArgumentException('non-nullable num_chars_per_line cannot be null'); + throw new \InvalidArgumentException('non-nullable num_chars_per_line cannot be null'); } $this->container['num_chars_per_line'] = $num_chars_per_line; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -371,11 +386,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -386,8 +401,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -400,9 +417,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -410,15 +429,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -444,3 +463,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateResponseSignerRole.php b/sdks/php/src/Model/TemplateResponseSignerRole.php index 98a80c6e0..4ab747fa4 100644 --- a/sdks/php/src/Model/TemplateResponseSignerRole.php +++ b/sdks/php/src/Model/TemplateResponseSignerRole.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateResponseSignerRole Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseSignerRole implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateResponseSignerRole implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseSignerRole'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', - 'order' => 'int', + 'order' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, - 'order' => null, + 'order' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'name' => false, - 'order' => false, + 'order' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'order' => 'order', + 'order' => 'order' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'order' => 'setOrder', + 'order' => 'setOrder' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'order' => 'getOrder', + 'order' => 'getOrder' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('order', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateResponseSignerRole { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateResponseSignerRole { /** @var TemplateResponseSignerRole */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateResponseSignerRole::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -288,7 +299,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -302,6 +315,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -315,14 +329,14 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Role + * @param string|null $name The name of the Role. * * @return self */ - public function setName(?string $name) + public function setName($name) { if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + throw new \InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -342,26 +356,27 @@ public function getOrder() /** * Sets order * - * @param int|null $order if signer order is assigned this is the 0-based index for this role + * @param int|null $order If signer order is assigned this is the 0-based index for this role. * * @return self */ - public function setOrder(?int $order) + public function setOrder($order) { if (is_null($order)) { - throw new InvalidArgumentException('non-nullable order cannot be null'); + throw new \InvalidArgumentException('non-nullable order cannot be null'); } $this->container['order'] = $order; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -370,11 +385,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -385,8 +400,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -399,9 +416,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -409,15 +428,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -443,3 +462,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateUpdateFilesRequest.php b/sdks/php/src/Model/TemplateUpdateFilesRequest.php index 7c165ff7d..8ff73ccc5 100644 --- a/sdks/php/src/Model/TemplateUpdateFilesRequest.php +++ b/sdks/php/src/Model/TemplateUpdateFilesRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,80 +29,78 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateUpdateFilesRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateUpdateFilesRequest implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateUpdateFilesRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateUpdateFilesRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'files' => '\SplFileObject[]', 'file_urls' => 'string[]', 'message' => 'string', 'subject' => 'string', - 'test_mode' => 'bool', + 'test_mode' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'files' => 'binary', 'file_urls' => null, 'message' => null, 'subject' => null, - 'test_mode' => null, + 'test_mode' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'files' => false, 'file_urls' => false, 'message' => false, 'subject' => false, - 'test_mode' => false, + 'test_mode' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -125,6 +125,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -134,7 +136,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -144,7 +146,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -153,6 +155,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -161,6 +166,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +187,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'file_urls', 'message' => 'message', 'subject' => 'subject', - 'test_mode' => 'test_mode', + 'test_mode' => 'test_mode' ]; /** @@ -193,7 +201,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'setFileUrls', 'message' => 'setMessage', 'subject' => 'setSubject', - 'test_mode' => 'setTestMode', + 'test_mode' => 'setTestMode' ]; /** @@ -207,7 +215,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'getFileUrls', 'message' => 'getMessage', 'subject' => 'getSubject', - 'test_mode' => 'getTestMode', + 'test_mode' => 'getTestMode' ]; /** @@ -251,6 +259,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -274,33 +283,34 @@ public function __construct(array $data = null) $this->setIfExists('test_mode', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateUpdateFilesRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateUpdateFilesRequest { /** @var TemplateUpdateFilesRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateUpdateFilesRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -341,6 +351,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets client_id * @@ -354,14 +365,14 @@ public function getClientId() /** * Sets client_id * - * @param string|null $client_id client id of the app you're using to update this template + * @param string|null $client_id Client id of the app you're using to update this template. * * @return self */ - public function setClientId(?string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -371,7 +382,7 @@ public function setClientId(?string $client_id) /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -381,14 +392,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to use for the template. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to use for the template. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -412,10 +423,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -435,17 +446,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the new default template email message + * @param string|null $message The new default template email message. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling TemplateUpdateFilesRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling TemplateUpdateFilesRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -466,17 +477,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the new default template email subject + * @param string|null $subject The new default template email subject. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 100) { - throw new InvalidArgumentException('invalid length for $subject when calling TemplateUpdateFilesRequest., must be smaller than or equal to 100.'); + if ((mb_strlen($subject) > 100)) { + throw new \InvalidArgumentException('invalid length for $subject when calling TemplateUpdateFilesRequest., must be smaller than or equal to 100.'); } $this->container['subject'] = $subject; @@ -501,22 +512,23 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -525,11 +537,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -540,8 +552,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -554,9 +568,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -564,15 +580,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -598,3 +614,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateUpdateFilesResponse.php b/sdks/php/src/Model/TemplateUpdateFilesResponse.php index d8080fb74..98dd2ae54 100644 --- a/sdks/php/src/Model/TemplateUpdateFilesResponse.php +++ b/sdks/php/src/Model/TemplateUpdateFilesResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,64 +29,63 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateUpdateFilesResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateUpdateFilesResponse implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateUpdateFilesResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateUpdateFilesResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'template' => '\Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate', + 'template' => '\Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'template' => null, + 'template' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ - 'template' => false, + 'template' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,6 +110,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -118,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -128,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -137,6 +140,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -145,6 +151,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -158,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'template' => 'template', + 'template' => 'template' ]; /** @@ -167,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'template' => 'setTemplate', + 'template' => 'setTemplate' ]; /** @@ -176,7 +185,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'template' => 'getTemplate', + 'template' => 'getTemplate' ]; /** @@ -220,6 +229,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -238,33 +248,34 @@ public function __construct(array $data = null) $this->setIfExists('template', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateUpdateFilesResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateUpdateFilesResponse { /** @var TemplateUpdateFilesResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateUpdateFilesResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,10 +311,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template * - * @return TemplateUpdateFilesResponseTemplate + * @return \Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate */ public function getTemplate() { @@ -313,26 +325,27 @@ public function getTemplate() /** * Sets template * - * @param TemplateUpdateFilesResponseTemplate $template template + * @param \Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate $template template * * @return self */ - public function setTemplate(TemplateUpdateFilesResponseTemplate $template) + public function setTemplate($template) { if (is_null($template)) { - throw new InvalidArgumentException('non-nullable template cannot be null'); + throw new \InvalidArgumentException('non-nullable template cannot be null'); } $this->container['template'] = $template; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -341,11 +354,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -356,8 +369,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -370,9 +385,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -380,15 +397,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -414,3 +431,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php index 70d2e87dc..e3b123e5b 100644 --- a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php +++ b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,68 +29,67 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * TemplateUpdateFilesResponseTemplate Class Doc Comment * * @category Class * @description Contains template id - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateUpdateFilesResponseTemplate implements ModelInterface, ArrayAccess, JsonSerializable +class TemplateUpdateFilesResponseTemplate implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateUpdateFilesResponseTemplate'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_id' => 'string', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_id' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'template_id' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -163,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'template_id' => 'template_id', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'template_id' => 'setTemplateId', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'template_id' => 'getTemplateId', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -227,6 +236,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -246,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): TemplateUpdateFilesResponseTemplate { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): TemplateUpdateFilesResponseTemplate { /** @var TemplateUpdateFilesResponseTemplate */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, TemplateUpdateFilesResponseTemplate::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -289,7 +300,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -303,6 +316,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets template_id * @@ -316,14 +330,14 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string|null $template_id The id of the Template. * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId($template_id) { if (is_null($template_id)) { - throw new InvalidArgumentException('non-nullable template_id cannot be null'); + throw new \InvalidArgumentException('non-nullable template_id cannot be null'); } $this->container['template_id'] = $template_id; @@ -333,7 +347,7 @@ public function setTemplateId(?string $template_id) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null * @deprecated */ public function getWarnings() @@ -344,27 +358,28 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self * @deprecated */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -373,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -388,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -402,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -412,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -446,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php index 8d4a7e3e2..658bed2c0 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,37 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * UnclaimedDraftCreateEmbeddedRequest Class Doc Comment * * @category Class - * @description - * @see https://openapi-generator.tech + * @description + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess, JsonSerializable +class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftCreateEmbeddedRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'requester_email_address' => 'string', @@ -94,16 +94,16 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'use_preexisting_fields' => 'bool', 'use_text_tags' => 'bool', 'populate_auto_fill_fields' => 'bool', - 'expires_at' => 'int', + 'expires_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'requester_email_address' => 'email', @@ -140,14 +140,14 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'use_preexisting_fields' => null, 'use_text_tags' => null, 'populate_auto_fill_fields' => null, - 'expires_at' => null, + 'expires_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'requester_email_address' => false, @@ -184,14 +184,14 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'use_preexisting_fields' => false, 'use_text_tags' => false, 'populate_auto_fill_fields' => false, - 'expires_at' => true, + 'expires_at' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -216,6 +216,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -225,7 +227,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -235,7 +237,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -244,6 +246,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -252,6 +257,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -300,7 +308,7 @@ public function isNullableSetToNull(string $property): bool 'use_preexisting_fields' => 'use_preexisting_fields', 'use_text_tags' => 'use_text_tags', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', - 'expires_at' => 'expires_at', + 'expires_at' => 'expires_at' ]; /** @@ -344,7 +352,7 @@ public function isNullableSetToNull(string $property): bool 'use_preexisting_fields' => 'setUsePreexistingFields', 'use_text_tags' => 'setUseTextTags', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', - 'expires_at' => 'setExpiresAt', + 'expires_at' => 'setExpiresAt' ]; /** @@ -388,7 +396,7 @@ public function isNullableSetToNull(string $property): bool 'use_preexisting_fields' => 'getUsePreexistingFields', 'use_text_tags' => 'getUseTextTags', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', - 'expires_at' => 'getExpiresAt', + 'expires_at' => 'getExpiresAt' ]; /** @@ -501,33 +509,34 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): UnclaimedDraftCreateEmbeddedRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): UnclaimedDraftCreateEmbeddedRequest { /** @var UnclaimedDraftCreateEmbeddedRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, UnclaimedDraftCreateEmbeddedRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -583,6 +592,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets client_id * @@ -600,10 +610,10 @@ public function getClientId() * * @return self */ - public function setClientId(string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -623,14 +633,14 @@ public function getRequesterEmailAddress() /** * Sets requester_email_address * - * @param string $requester_email_address the email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature` + * @param string $requester_email_address The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. * * @return self */ - public function setRequesterEmailAddress(string $requester_email_address) + public function setRequesterEmailAddress($requester_email_address) { if (is_null($requester_email_address)) { - throw new InvalidArgumentException('non-nullable requester_email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable requester_email_address cannot be null'); } $this->container['requester_email_address'] = $requester_email_address; @@ -640,7 +650,7 @@ public function setRequesterEmailAddress(string $requester_email_address) /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -650,14 +660,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -681,10 +691,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -704,14 +714,14 @@ public function getAllowCcs() /** * Sets allow_ccs * - * @param bool|null $allow_ccs this allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft + * @param bool|null $allow_ccs This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. * * @return self */ - public function setAllowCcs(?bool $allow_ccs) + public function setAllowCcs($allow_ccs) { if (is_null($allow_ccs)) { - throw new InvalidArgumentException('non-nullable allow_ccs cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_ccs cannot be null'); } $this->container['allow_ccs'] = $allow_ccs; @@ -735,10 +745,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline(?bool $allow_decline) + public function setAllowDecline($allow_decline) { if (is_null($allow_decline)) { - throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -762,10 +772,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign(?bool $allow_reassign) + public function setAllowReassign($allow_reassign) { if (is_null($allow_reassign)) { - throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -775,7 +785,7 @@ public function setAllowReassign(?bool $allow_reassign) /** * Gets attachments * - * @return SubAttachment[]|null + * @return \Dropbox\Sign\Model\SubAttachment[]|null */ public function getAttachments() { @@ -785,14 +795,14 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments(?array $attachments) + public function setAttachments($attachments) { if (is_null($attachments)) { - throw new InvalidArgumentException('non-nullable attachments cannot be null'); + throw new \InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -812,14 +822,14 @@ public function getCcEmailAddresses() /** * Sets cc_email_addresses * - * @param string[]|null $cc_email_addresses the email addresses that should be CCed + * @param string[]|null $cc_email_addresses The email addresses that should be CCed. * * @return self */ - public function setCcEmailAddresses(?array $cc_email_addresses) + public function setCcEmailAddresses($cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -829,7 +839,7 @@ public function setCcEmailAddresses(?array $cc_email_addresses) /** * Gets custom_fields * - * @return SubCustomField[]|null + * @return \Dropbox\Sign\Model\SubCustomField[]|null */ public function getCustomFields() { @@ -839,14 +849,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -856,7 +866,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets editor_options * - * @return SubEditorOptions|null + * @return \Dropbox\Sign\Model\SubEditorOptions|null */ public function getEditorOptions() { @@ -866,14 +876,14 @@ public function getEditorOptions() /** * Sets editor_options * - * @param SubEditorOptions|null $editor_options editor_options + * @param \Dropbox\Sign\Model\SubEditorOptions|null $editor_options editor_options * * @return self */ - public function setEditorOptions(?SubEditorOptions $editor_options) + public function setEditorOptions($editor_options) { if (is_null($editor_options)) { - throw new InvalidArgumentException('non-nullable editor_options cannot be null'); + throw new \InvalidArgumentException('non-nullable editor_options cannot be null'); } $this->container['editor_options'] = $editor_options; @@ -883,7 +893,7 @@ public function setEditorOptions(?SubEditorOptions $editor_options) /** * Gets field_options * - * @return SubFieldOptions|null + * @return \Dropbox\Sign\Model\SubFieldOptions|null */ public function getFieldOptions() { @@ -893,14 +903,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param SubFieldOptions|null $field_options field_options + * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions(?SubFieldOptions $field_options) + public function setFieldOptions($field_options) { if (is_null($field_options)) { - throw new InvalidArgumentException('non-nullable field_options cannot be null'); + throw new \InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -920,14 +930,14 @@ public function getForceSignerPage() /** * Sets force_signer_page * - * @param bool|null $force_signer_page provide users the ability to review/edit the signers + * @param bool|null $force_signer_page Provide users the ability to review/edit the signers. * * @return self */ - public function setForceSignerPage(?bool $force_signer_page) + public function setForceSignerPage($force_signer_page) { if (is_null($force_signer_page)) { - throw new InvalidArgumentException('non-nullable force_signer_page cannot be null'); + throw new \InvalidArgumentException('non-nullable force_signer_page cannot be null'); } $this->container['force_signer_page'] = $force_signer_page; @@ -947,14 +957,14 @@ public function getForceSubjectMessage() /** * Sets force_subject_message * - * @param bool|null $force_subject_message provide users the ability to review/edit the subject and message + * @param bool|null $force_subject_message Provide users the ability to review/edit the subject and message. * * @return self */ - public function setForceSubjectMessage(?bool $force_subject_message) + public function setForceSubjectMessage($force_subject_message) { if (is_null($force_subject_message)) { - throw new InvalidArgumentException('non-nullable force_subject_message cannot be null'); + throw new \InvalidArgumentException('non-nullable force_subject_message cannot be null'); } $this->container['force_subject_message'] = $force_subject_message; @@ -964,7 +974,7 @@ public function setForceSubjectMessage(?bool $force_subject_message) /** * Gets form_field_groups * - * @return SubFormFieldGroup[]|null + * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -974,14 +984,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups(?array $form_field_groups) + public function setFormFieldGroups($form_field_groups) { if (is_null($form_field_groups)) { - throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -991,7 +1001,7 @@ public function setFormFieldGroups(?array $form_field_groups) /** * Gets form_field_rules * - * @return SubFormFieldRule[]|null + * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -1001,14 +1011,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` + * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. * * @return self */ - public function setFormFieldRules(?array $form_field_rules) + public function setFormFieldRules($form_field_rules) { if (is_null($form_field_rules)) { - throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -1018,7 +1028,7 @@ public function setFormFieldRules(?array $form_field_rules) /** * Gets form_fields_per_document * - * @return SubFormFieldsPerDocumentBase[]|null + * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null */ public function getFormFieldsPerDocument() { @@ -1028,14 +1038,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument(?array $form_fields_per_document) + public function setFormFieldsPerDocument($form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -1059,10 +1069,10 @@ public function getHideTextTags() * * @return self */ - public function setHideTextTags(?bool $hide_text_tags) + public function setHideTextTags($hide_text_tags) { if (is_null($hide_text_tags)) { - throw new InvalidArgumentException('non-nullable hide_text_tags cannot be null'); + throw new \InvalidArgumentException('non-nullable hide_text_tags cannot be null'); } $this->container['hide_text_tags'] = $hide_text_tags; @@ -1086,10 +1096,10 @@ public function getHoldRequest() * * @return self */ - public function setHoldRequest(?bool $hold_request) + public function setHoldRequest($hold_request) { if (is_null($hold_request)) { - throw new InvalidArgumentException('non-nullable hold_request cannot be null'); + throw new \InvalidArgumentException('non-nullable hold_request cannot be null'); } $this->container['hold_request'] = $hold_request; @@ -1113,10 +1123,10 @@ public function getIsForEmbeddedSigning() * * @return self */ - public function setIsForEmbeddedSigning(?bool $is_for_embedded_signing) + public function setIsForEmbeddedSigning($is_for_embedded_signing) { if (is_null($is_for_embedded_signing)) { - throw new InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); + throw new \InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); } $this->container['is_for_embedded_signing'] = $is_for_embedded_signing; @@ -1136,17 +1146,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that will be sent to the signers + * @param string|null $message The custom message in the email that will be sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateEmbeddedRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateEmbeddedRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -1171,12 +1181,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -1195,14 +1206,14 @@ public function getRequestingRedirectUrl() /** * Sets requesting_redirect_url * - * @param string|null $requesting_redirect_url the URL you want signers redirected to after they successfully request a signature + * @param string|null $requesting_redirect_url The URL you want signers redirected to after they successfully request a signature. * * @return self */ - public function setRequestingRedirectUrl(?string $requesting_redirect_url) + public function setRequestingRedirectUrl($requesting_redirect_url) { if (is_null($requesting_redirect_url)) { - throw new InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); } $this->container['requesting_redirect_url'] = $requesting_redirect_url; @@ -1226,10 +1237,10 @@ public function getShowPreview() * * @return self */ - public function setShowPreview(?bool $show_preview) + public function setShowPreview($show_preview) { if (is_null($show_preview)) { - throw new InvalidArgumentException('non-nullable show_preview cannot be null'); + throw new \InvalidArgumentException('non-nullable show_preview cannot be null'); } $this->container['show_preview'] = $show_preview; @@ -1249,14 +1260,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden + * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. * * @return self */ - public function setShowProgressStepper(?bool $show_progress_stepper) + public function setShowProgressStepper($show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -1266,7 +1277,7 @@ public function setShowProgressStepper(?bool $show_progress_stepper) /** * Gets signers * - * @return SubUnclaimedDraftSigner[]|null + * @return \Dropbox\Sign\Model\SubUnclaimedDraftSigner[]|null */ public function getSigners() { @@ -1276,14 +1287,14 @@ public function getSigners() /** * Sets signers * - * @param SubUnclaimedDraftSigner[]|null $signers add Signers to your Unclaimed Draft Signature Request + * @param \Dropbox\Sign\Model\SubUnclaimedDraftSigner[]|null $signers Add Signers to your Unclaimed Draft Signature Request. * * @return self */ - public function setSigners(?array $signers) + public function setSigners($signers) { if (is_null($signers)) { - throw new InvalidArgumentException('non-nullable signers cannot be null'); + throw new \InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -1293,7 +1304,7 @@ public function setSigners(?array $signers) /** * Gets signing_options * - * @return SubSigningOptions|null + * @return \Dropbox\Sign\Model\SubSigningOptions|null */ public function getSigningOptions() { @@ -1303,14 +1314,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param SubSigningOptions|null $signing_options signing_options + * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions(?SubSigningOptions $signing_options) + public function setSigningOptions($signing_options) { if (is_null($signing_options)) { - throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -1330,14 +1341,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -1361,10 +1372,10 @@ public function getSkipMeNow() * * @return self */ - public function setSkipMeNow(?bool $skip_me_now) + public function setSkipMeNow($skip_me_now) { if (is_null($skip_me_now)) { - throw new InvalidArgumentException('non-nullable skip_me_now cannot be null'); + throw new \InvalidArgumentException('non-nullable skip_me_now cannot be null'); } $this->container['skip_me_now'] = $skip_me_now; @@ -1384,17 +1395,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that will be sent to the signers + * @param string|null $subject The subject in the email that will be sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 200) { - throw new InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateEmbeddedRequest., must be smaller than or equal to 200.'); + if ((mb_strlen($subject) > 200)) { + throw new \InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateEmbeddedRequest., must be smaller than or equal to 200.'); } $this->container['subject'] = $subject; @@ -1419,10 +1430,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1446,14 +1457,14 @@ public function getType() * * @return self */ - public function setType(?string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'type', must be one of '%s'", $type, @@ -1483,10 +1494,10 @@ public function getUsePreexistingFields() * * @return self */ - public function setUsePreexistingFields(?bool $use_preexisting_fields) + public function setUsePreexistingFields($use_preexisting_fields) { if (is_null($use_preexisting_fields)) { - throw new InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); } $this->container['use_preexisting_fields'] = $use_preexisting_fields; @@ -1510,10 +1521,10 @@ public function getUseTextTags() * * @return self */ - public function setUseTextTags(?bool $use_text_tags) + public function setUseTextTags($use_text_tags) { if (is_null($use_text_tags)) { - throw new InvalidArgumentException('non-nullable use_text_tags cannot be null'); + throw new \InvalidArgumentException('non-nullable use_text_tags cannot be null'); } $this->container['use_text_tags'] = $use_text_tags; @@ -1537,10 +1548,10 @@ public function getPopulateAutoFillFields() * * @return self */ - public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) + public function setPopulateAutoFillFields($populate_auto_fill_fields) { if (is_null($populate_auto_fill_fields)) { - throw new InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); } $this->container['populate_auto_fill_fields'] = $populate_auto_fill_fields; @@ -1564,14 +1575,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1580,13 +1591,14 @@ public function setExpiresAt(?int $expires_at) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1595,11 +1607,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1610,8 +1622,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1624,9 +1638,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1634,15 +1650,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1668,3 +1684,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php index df0b1df69..fdc7ee890 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,36 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * UnclaimedDraftCreateEmbeddedWithTemplateRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftCreateEmbeddedWithTemplateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'requester_email_address' => 'string', @@ -87,16 +87,16 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface, 'test_mode' => 'bool', 'title' => 'string', 'populate_auto_fill_fields' => 'bool', - 'allow_ccs' => 'bool', + 'allow_ccs' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'requester_email_address' => 'email', @@ -127,14 +127,14 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface, 'test_mode' => null, 'title' => null, 'populate_auto_fill_fields' => null, - 'allow_ccs' => null, + 'allow_ccs' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'requester_email_address' => false, @@ -165,14 +165,14 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface, 'test_mode' => false, 'title' => false, 'populate_auto_fill_fields' => false, - 'allow_ccs' => false, + 'allow_ccs' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -197,6 +197,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -206,7 +208,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -216,7 +218,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -225,6 +227,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -233,6 +238,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -275,7 +283,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', - 'allow_ccs' => 'allow_ccs', + 'allow_ccs' => 'allow_ccs' ]; /** @@ -313,7 +321,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', - 'allow_ccs' => 'setAllowCcs', + 'allow_ccs' => 'setAllowCcs' ]; /** @@ -351,7 +359,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', - 'allow_ccs' => 'getAllowCcs', + 'allow_ccs' => 'getAllowCcs' ]; /** @@ -395,6 +403,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -442,33 +451,34 @@ public function __construct(array $data = null) $this->setIfExists('allow_ccs', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): UnclaimedDraftCreateEmbeddedWithTemplateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): UnclaimedDraftCreateEmbeddedWithTemplateRequest { /** @var UnclaimedDraftCreateEmbeddedWithTemplateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, UnclaimedDraftCreateEmbeddedWithTemplateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -522,6 +532,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets client_id * @@ -539,10 +550,10 @@ public function getClientId() * * @return self */ - public function setClientId(string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -562,14 +573,14 @@ public function getRequesterEmailAddress() /** * Sets requester_email_address * - * @param string $requester_email_address the email address of the user that should be designated as the requester of this draft + * @param string $requester_email_address The email address of the user that should be designated as the requester of this draft. * * @return self */ - public function setRequesterEmailAddress(string $requester_email_address) + public function setRequesterEmailAddress($requester_email_address) { if (is_null($requester_email_address)) { - throw new InvalidArgumentException('non-nullable requester_email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable requester_email_address cannot be null'); } $this->container['requester_email_address'] = $requester_email_address; @@ -589,14 +600,14 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used + * @param string[] $template_ids Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. * * @return self */ - public function setTemplateIds(array $template_ids) + public function setTemplateIds($template_ids) { if (is_null($template_ids)) { - throw new InvalidArgumentException('non-nullable template_ids cannot be null'); + throw new \InvalidArgumentException('non-nullable template_ids cannot be null'); } $this->container['template_ids'] = $template_ids; @@ -620,10 +631,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline(?bool $allow_decline) + public function setAllowDecline($allow_decline) { if (is_null($allow_decline)) { - throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -647,10 +658,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign(?bool $allow_reassign) + public function setAllowReassign($allow_reassign) { if (is_null($allow_reassign)) { - throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -660,7 +671,7 @@ public function setAllowReassign(?bool $allow_reassign) /** * Gets ccs * - * @return SubCC[]|null + * @return \Dropbox\Sign\Model\SubCC[]|null */ public function getCcs() { @@ -670,14 +681,14 @@ public function getCcs() /** * Sets ccs * - * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * @param \Dropbox\Sign\Model\SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. * * @return self */ - public function setCcs(?array $ccs) + public function setCcs($ccs) { if (is_null($ccs)) { - throw new InvalidArgumentException('non-nullable ccs cannot be null'); + throw new \InvalidArgumentException('non-nullable ccs cannot be null'); } $this->container['ccs'] = $ccs; @@ -687,7 +698,7 @@ public function setCcs(?array $ccs) /** * Gets custom_fields * - * @return SubCustomField[]|null + * @return \Dropbox\Sign\Model\SubCustomField[]|null */ public function getCustomFields() { @@ -697,14 +708,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. + * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -714,7 +725,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets editor_options * - * @return SubEditorOptions|null + * @return \Dropbox\Sign\Model\SubEditorOptions|null */ public function getEditorOptions() { @@ -724,14 +735,14 @@ public function getEditorOptions() /** * Sets editor_options * - * @param SubEditorOptions|null $editor_options editor_options + * @param \Dropbox\Sign\Model\SubEditorOptions|null $editor_options editor_options * * @return self */ - public function setEditorOptions(?SubEditorOptions $editor_options) + public function setEditorOptions($editor_options) { if (is_null($editor_options)) { - throw new InvalidArgumentException('non-nullable editor_options cannot be null'); + throw new \InvalidArgumentException('non-nullable editor_options cannot be null'); } $this->container['editor_options'] = $editor_options; @@ -741,7 +752,7 @@ public function setEditorOptions(?SubEditorOptions $editor_options) /** * Gets field_options * - * @return SubFieldOptions|null + * @return \Dropbox\Sign\Model\SubFieldOptions|null */ public function getFieldOptions() { @@ -751,14 +762,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param SubFieldOptions|null $field_options field_options + * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions(?SubFieldOptions $field_options) + public function setFieldOptions($field_options) { if (is_null($field_options)) { - throw new InvalidArgumentException('non-nullable field_options cannot be null'); + throw new \InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -768,7 +779,7 @@ public function setFieldOptions(?SubFieldOptions $field_options) /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -778,14 +789,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both. + * @param \SplFileObject[]|null $files Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -809,10 +820,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -832,14 +843,14 @@ public function getForceSignerRoles() /** * Sets force_signer_roles * - * @param bool|null $force_signer_roles provide users the ability to review/edit the template signer roles + * @param bool|null $force_signer_roles Provide users the ability to review/edit the template signer roles. * * @return self */ - public function setForceSignerRoles(?bool $force_signer_roles) + public function setForceSignerRoles($force_signer_roles) { if (is_null($force_signer_roles)) { - throw new InvalidArgumentException('non-nullable force_signer_roles cannot be null'); + throw new \InvalidArgumentException('non-nullable force_signer_roles cannot be null'); } $this->container['force_signer_roles'] = $force_signer_roles; @@ -859,14 +870,14 @@ public function getForceSubjectMessage() /** * Sets force_subject_message * - * @param bool|null $force_subject_message provide users the ability to review/edit the template subject and message + * @param bool|null $force_subject_message Provide users the ability to review/edit the template subject and message. * * @return self */ - public function setForceSubjectMessage(?bool $force_subject_message) + public function setForceSubjectMessage($force_subject_message) { if (is_null($force_subject_message)) { - throw new InvalidArgumentException('non-nullable force_subject_message cannot be null'); + throw new \InvalidArgumentException('non-nullable force_subject_message cannot be null'); } $this->container['force_subject_message'] = $force_subject_message; @@ -890,10 +901,10 @@ public function getHoldRequest() * * @return self */ - public function setHoldRequest(?bool $hold_request) + public function setHoldRequest($hold_request) { if (is_null($hold_request)) { - throw new InvalidArgumentException('non-nullable hold_request cannot be null'); + throw new \InvalidArgumentException('non-nullable hold_request cannot be null'); } $this->container['hold_request'] = $hold_request; @@ -917,10 +928,10 @@ public function getIsForEmbeddedSigning() * * @return self */ - public function setIsForEmbeddedSigning(?bool $is_for_embedded_signing) + public function setIsForEmbeddedSigning($is_for_embedded_signing) { if (is_null($is_for_embedded_signing)) { - throw new InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); + throw new \InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); } $this->container['is_for_embedded_signing'] = $is_for_embedded_signing; @@ -940,17 +951,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that will be sent to the signers + * @param string|null $message The custom message in the email that will be sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -975,12 +986,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -1003,10 +1015,10 @@ public function getPreviewOnly() * * @return self */ - public function setPreviewOnly(?bool $preview_only) + public function setPreviewOnly($preview_only) { if (is_null($preview_only)) { - throw new InvalidArgumentException('non-nullable preview_only cannot be null'); + throw new \InvalidArgumentException('non-nullable preview_only cannot be null'); } $this->container['preview_only'] = $preview_only; @@ -1026,14 +1038,14 @@ public function getRequestingRedirectUrl() /** * Sets requesting_redirect_url * - * @param string|null $requesting_redirect_url the URL you want signers redirected to after they successfully request a signature + * @param string|null $requesting_redirect_url The URL you want signers redirected to after they successfully request a signature. * * @return self */ - public function setRequestingRedirectUrl(?string $requesting_redirect_url) + public function setRequestingRedirectUrl($requesting_redirect_url) { if (is_null($requesting_redirect_url)) { - throw new InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); } $this->container['requesting_redirect_url'] = $requesting_redirect_url; @@ -1057,10 +1069,10 @@ public function getShowPreview() * * @return self */ - public function setShowPreview(?bool $show_preview) + public function setShowPreview($show_preview) { if (is_null($show_preview)) { - throw new InvalidArgumentException('non-nullable show_preview cannot be null'); + throw new \InvalidArgumentException('non-nullable show_preview cannot be null'); } $this->container['show_preview'] = $show_preview; @@ -1080,14 +1092,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden + * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. * * @return self */ - public function setShowProgressStepper(?bool $show_progress_stepper) + public function setShowProgressStepper($show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -1097,7 +1109,7 @@ public function setShowProgressStepper(?bool $show_progress_stepper) /** * Gets signers * - * @return SubUnclaimedDraftTemplateSigner[]|null + * @return \Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner[]|null */ public function getSigners() { @@ -1107,14 +1119,14 @@ public function getSigners() /** * Sets signers * - * @param SubUnclaimedDraftTemplateSigner[]|null $signers add Signers to your Templated-based Signature Request + * @param \Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner[]|null $signers Add Signers to your Templated-based Signature Request. * * @return self */ - public function setSigners(?array $signers) + public function setSigners($signers) { if (is_null($signers)) { - throw new InvalidArgumentException('non-nullable signers cannot be null'); + throw new \InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -1124,7 +1136,7 @@ public function setSigners(?array $signers) /** * Gets signing_options * - * @return SubSigningOptions|null + * @return \Dropbox\Sign\Model\SubSigningOptions|null */ public function getSigningOptions() { @@ -1134,14 +1146,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param SubSigningOptions|null $signing_options signing_options + * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions(?SubSigningOptions $signing_options) + public function setSigningOptions($signing_options) { if (is_null($signing_options)) { - throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -1161,14 +1173,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -1192,10 +1204,10 @@ public function getSkipMeNow() * * @return self */ - public function setSkipMeNow(?bool $skip_me_now) + public function setSkipMeNow($skip_me_now) { if (is_null($skip_me_now)) { - throw new InvalidArgumentException('non-nullable skip_me_now cannot be null'); + throw new \InvalidArgumentException('non-nullable skip_me_now cannot be null'); } $this->container['skip_me_now'] = $skip_me_now; @@ -1215,17 +1227,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that will be sent to the signers + * @param string|null $subject The subject in the email that will be sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 255) { - throw new InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($subject) > 255)) { + throw new \InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -1250,10 +1262,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1273,17 +1285,17 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title you want to assign to the SignatureRequest + * @param string|null $title The title you want to assign to the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle($title) { if (is_null($title)) { - throw new InvalidArgumentException('non-nullable title cannot be null'); + throw new \InvalidArgumentException('non-nullable title cannot be null'); } - if (mb_strlen($title) > 255) { - throw new InvalidArgumentException('invalid length for $title when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if ((mb_strlen($title) > 255)) { + throw new \InvalidArgumentException('invalid length for $title when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; @@ -1308,10 +1320,10 @@ public function getPopulateAutoFillFields() * * @return self */ - public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) + public function setPopulateAutoFillFields($populate_auto_fill_fields) { if (is_null($populate_auto_fill_fields)) { - throw new InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); } $this->container['populate_auto_fill_fields'] = $populate_auto_fill_fields; @@ -1331,26 +1343,27 @@ public function getAllowCcs() /** * Sets allow_ccs * - * @param bool|null $allow_ccs this allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft + * @param bool|null $allow_ccs This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. * * @return self */ - public function setAllowCcs(?bool $allow_ccs) + public function setAllowCcs($allow_ccs) { if (is_null($allow_ccs)) { - throw new InvalidArgumentException('non-nullable allow_ccs cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_ccs cannot be null'); } $this->container['allow_ccs'] = $allow_ccs; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1359,11 +1372,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1374,8 +1387,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1388,9 +1403,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1398,15 +1415,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1432,3 +1449,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php index 1d55c2c1b..7cc9353d8 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,37 +29,35 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; -use SplFileObject; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * UnclaimedDraftCreateRequest Class Doc Comment * * @category Class - * @description - * @see https://openapi-generator.tech + * @description + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable +class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'files' => '\SplFileObject[]', @@ -82,16 +82,16 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => 'bool', 'use_preexisting_fields' => 'bool', 'use_text_tags' => 'bool', - 'expires_at' => 'int', + 'expires_at' => 'int' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'files' => 'binary', @@ -116,14 +116,14 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => null, 'use_preexisting_fields' => null, 'use_text_tags' => null, - 'expires_at' => null, + 'expires_at' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'type' => false, 'files' => false, @@ -148,14 +148,14 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => false, 'use_preexisting_fields' => false, 'use_text_tags' => false, - 'expires_at' => true, + 'expires_at' => true ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -180,6 +180,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -189,7 +191,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -199,7 +201,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -208,6 +210,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -216,6 +221,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -252,7 +260,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'use_preexisting_fields' => 'use_preexisting_fields', 'use_text_tags' => 'use_text_tags', - 'expires_at' => 'expires_at', + 'expires_at' => 'expires_at' ]; /** @@ -284,7 +292,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'use_preexisting_fields' => 'setUsePreexistingFields', 'use_text_tags' => 'setUseTextTags', - 'expires_at' => 'setExpiresAt', + 'expires_at' => 'setExpiresAt' ]; /** @@ -316,7 +324,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'use_preexisting_fields' => 'getUsePreexistingFields', 'use_text_tags' => 'getUseTextTags', - 'expires_at' => 'getExpiresAt', + 'expires_at' => 'getExpiresAt' ]; /** @@ -417,33 +425,34 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): UnclaimedDraftCreateRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): UnclaimedDraftCreateRequest { /** @var UnclaimedDraftCreateRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, UnclaimedDraftCreateRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -496,6 +505,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -513,14 +523,14 @@ public function getType() * * @return self */ - public function setType(string $type) + public function setType($type) { if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + throw new \InvalidArgumentException('non-nullable type cannot be null'); } $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { - throw new InvalidArgumentException( + throw new \InvalidArgumentException( sprintf( "Invalid value '%s' for 'type', must be one of '%s'", $type, @@ -536,7 +546,7 @@ public function setType(string $type) /** * Gets files * - * @return SplFileObject[]|null + * @return \SplFileObject[]|null */ public function getFiles() { @@ -546,14 +556,14 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles(?array $files) + public function setFiles($files) { if (is_null($files)) { - throw new InvalidArgumentException('non-nullable files cannot be null'); + throw new \InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -577,10 +587,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls(?array $file_urls) + public function setFileUrls($file_urls) { if (is_null($file_urls)) { - throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -604,10 +614,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline(?bool $allow_decline) + public function setAllowDecline($allow_decline) { if (is_null($allow_decline)) { - throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -617,7 +627,7 @@ public function setAllowDecline(?bool $allow_decline) /** * Gets attachments * - * @return SubAttachment[]|null + * @return \Dropbox\Sign\Model\SubAttachment[]|null */ public function getAttachments() { @@ -627,14 +637,14 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments(?array $attachments) + public function setAttachments($attachments) { if (is_null($attachments)) { - throw new InvalidArgumentException('non-nullable attachments cannot be null'); + throw new \InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -654,14 +664,14 @@ public function getCcEmailAddresses() /** * Sets cc_email_addresses * - * @param string[]|null $cc_email_addresses the email addresses that should be CCed + * @param string[]|null $cc_email_addresses The email addresses that should be CCed. * * @return self */ - public function setCcEmailAddresses(?array $cc_email_addresses) + public function setCcEmailAddresses($cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -685,10 +695,10 @@ public function getClientId() * * @return self */ - public function setClientId(?string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -698,7 +708,7 @@ public function setClientId(?string $client_id) /** * Gets custom_fields * - * @return SubCustomField[]|null + * @return \Dropbox\Sign\Model\SubCustomField[]|null */ public function getCustomFields() { @@ -708,14 +718,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields($custom_fields) { if (is_null($custom_fields)) { - throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -725,7 +735,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets field_options * - * @return SubFieldOptions|null + * @return \Dropbox\Sign\Model\SubFieldOptions|null */ public function getFieldOptions() { @@ -735,14 +745,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param SubFieldOptions|null $field_options field_options + * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions(?SubFieldOptions $field_options) + public function setFieldOptions($field_options) { if (is_null($field_options)) { - throw new InvalidArgumentException('non-nullable field_options cannot be null'); + throw new \InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -752,7 +762,7 @@ public function setFieldOptions(?SubFieldOptions $field_options) /** * Gets form_field_groups * - * @return SubFormFieldGroup[]|null + * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -762,14 +772,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups(?array $form_field_groups) + public function setFormFieldGroups($form_field_groups) { if (is_null($form_field_groups)) { - throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -779,7 +789,7 @@ public function setFormFieldGroups(?array $form_field_groups) /** * Gets form_field_rules * - * @return SubFormFieldRule[]|null + * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -789,14 +799,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` + * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. * * @return self */ - public function setFormFieldRules(?array $form_field_rules) + public function setFormFieldRules($form_field_rules) { if (is_null($form_field_rules)) { - throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -806,7 +816,7 @@ public function setFormFieldRules(?array $form_field_rules) /** * Gets form_fields_per_document * - * @return SubFormFieldsPerDocumentBase[]|null + * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null */ public function getFormFieldsPerDocument() { @@ -816,14 +826,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument(?array $form_fields_per_document) + public function setFormFieldsPerDocument($form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -847,10 +857,10 @@ public function getHideTextTags() * * @return self */ - public function setHideTextTags(?bool $hide_text_tags) + public function setHideTextTags($hide_text_tags) { if (is_null($hide_text_tags)) { - throw new InvalidArgumentException('non-nullable hide_text_tags cannot be null'); + throw new \InvalidArgumentException('non-nullable hide_text_tags cannot be null'); } $this->container['hide_text_tags'] = $hide_text_tags; @@ -870,17 +880,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that will be sent to the signers + * @param string|null $message The custom message in the email that will be sent to the signers. * * @return self */ - public function setMessage(?string $message) + public function setMessage($message) { if (is_null($message)) { - throw new InvalidArgumentException('non-nullable message cannot be null'); + throw new \InvalidArgumentException('non-nullable message cannot be null'); } - if (mb_strlen($message) > 5000) { - throw new InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateRequest., must be smaller than or equal to 5000.'); + if ((mb_strlen($message) > 5000)) { + throw new \InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -905,12 +915,13 @@ public function getMetadata() * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata($metadata) { if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); + throw new \InvalidArgumentException('non-nullable metadata cannot be null'); } + $this->container['metadata'] = $metadata; return $this; @@ -929,14 +940,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden + * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. * * @return self */ - public function setShowProgressStepper(?bool $show_progress_stepper) + public function setShowProgressStepper($show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -946,7 +957,7 @@ public function setShowProgressStepper(?bool $show_progress_stepper) /** * Gets signers * - * @return SubUnclaimedDraftSigner[]|null + * @return \Dropbox\Sign\Model\SubUnclaimedDraftSigner[]|null */ public function getSigners() { @@ -956,14 +967,14 @@ public function getSigners() /** * Sets signers * - * @param SubUnclaimedDraftSigner[]|null $signers add Signers to your Unclaimed Draft Signature Request + * @param \Dropbox\Sign\Model\SubUnclaimedDraftSigner[]|null $signers Add Signers to your Unclaimed Draft Signature Request. * * @return self */ - public function setSigners(?array $signers) + public function setSigners($signers) { if (is_null($signers)) { - throw new InvalidArgumentException('non-nullable signers cannot be null'); + throw new \InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -973,7 +984,7 @@ public function setSigners(?array $signers) /** * Gets signing_options * - * @return SubSigningOptions|null + * @return \Dropbox\Sign\Model\SubSigningOptions|null */ public function getSigningOptions() { @@ -983,14 +994,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param SubSigningOptions|null $signing_options signing_options + * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions(?SubSigningOptions $signing_options) + public function setSigningOptions($signing_options) { if (is_null($signing_options)) { - throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -1010,14 +1021,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -1037,17 +1048,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that will be sent to the signers + * @param string|null $subject The subject in the email that will be sent to the signers. * * @return self */ - public function setSubject(?string $subject) + public function setSubject($subject) { if (is_null($subject)) { - throw new InvalidArgumentException('non-nullable subject cannot be null'); + throw new \InvalidArgumentException('non-nullable subject cannot be null'); } - if (mb_strlen($subject) > 200) { - throw new InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateRequest., must be smaller than or equal to 200.'); + if ((mb_strlen($subject) > 200)) { + throw new \InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateRequest., must be smaller than or equal to 200.'); } $this->container['subject'] = $subject; @@ -1072,10 +1083,10 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1099,10 +1110,10 @@ public function getUsePreexistingFields() * * @return self */ - public function setUsePreexistingFields(?bool $use_preexisting_fields) + public function setUsePreexistingFields($use_preexisting_fields) { if (is_null($use_preexisting_fields)) { - throw new InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); + throw new \InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); } $this->container['use_preexisting_fields'] = $use_preexisting_fields; @@ -1126,10 +1137,10 @@ public function getUseTextTags() * * @return self */ - public function setUseTextTags(?bool $use_text_tags) + public function setUseTextTags($use_text_tags) { if (is_null($use_text_tags)) { - throw new InvalidArgumentException('non-nullable use_text_tags cannot be null'); + throw new \InvalidArgumentException('non-nullable use_text_tags cannot be null'); } $this->container['use_text_tags'] = $use_text_tags; @@ -1153,14 +1164,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1169,13 +1180,14 @@ public function setExpiresAt(?int $expires_at) return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1184,11 +1196,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1199,8 +1211,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1213,9 +1227,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1223,15 +1239,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1257,3 +1273,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/UnclaimedDraftCreateResponse.php b/sdks/php/src/Model/UnclaimedDraftCreateResponse.php index fb93528ef..4bacee2f5 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateResponse.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,67 +29,66 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * UnclaimedDraftCreateResponse Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftCreateResponse implements ModelInterface, ArrayAccess, JsonSerializable +class UnclaimedDraftCreateResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftCreateResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'unclaimed_draft' => '\Dropbox\Sign\Model\UnclaimedDraftResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'unclaimed_draft' => null, - 'warnings' => null, + 'warnings' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'unclaimed_draft' => false, - 'warnings' => false, + 'warnings' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,6 +113,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -121,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,6 +143,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -148,6 +154,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -162,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'unclaimed_draft' => 'unclaimed_draft', - 'warnings' => 'warnings', + 'warnings' => 'warnings' ]; /** @@ -172,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'unclaimed_draft' => 'setUnclaimedDraft', - 'warnings' => 'setWarnings', + 'warnings' => 'setWarnings' ]; /** @@ -182,7 +191,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'unclaimed_draft' => 'getUnclaimedDraft', - 'warnings' => 'getWarnings', + 'warnings' => 'getWarnings' ]; /** @@ -226,6 +235,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,33 +255,34 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): UnclaimedDraftCreateResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): UnclaimedDraftCreateResponse { /** @var UnclaimedDraftCreateResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, UnclaimedDraftCreateResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -307,10 +318,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets unclaimed_draft * - * @return UnclaimedDraftResponse + * @return \Dropbox\Sign\Model\UnclaimedDraftResponse */ public function getUnclaimedDraft() { @@ -320,14 +332,14 @@ public function getUnclaimedDraft() /** * Sets unclaimed_draft * - * @param UnclaimedDraftResponse $unclaimed_draft unclaimed_draft + * @param \Dropbox\Sign\Model\UnclaimedDraftResponse $unclaimed_draft unclaimed_draft * * @return self */ - public function setUnclaimedDraft(UnclaimedDraftResponse $unclaimed_draft) + public function setUnclaimedDraft($unclaimed_draft) { if (is_null($unclaimed_draft)) { - throw new InvalidArgumentException('non-nullable unclaimed_draft cannot be null'); + throw new \InvalidArgumentException('non-nullable unclaimed_draft cannot be null'); } $this->container['unclaimed_draft'] = $unclaimed_draft; @@ -337,7 +349,7 @@ public function setUnclaimedDraft(UnclaimedDraftResponse $unclaimed_draft) /** * Gets warnings * - * @return WarningResponse[]|null + * @return \Dropbox\Sign\Model\WarningResponse[]|null */ public function getWarnings() { @@ -347,26 +359,27 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. * * @return self */ - public function setWarnings(?array $warnings) + public function setWarnings($warnings) { if (is_null($warnings)) { - throw new InvalidArgumentException('non-nullable warnings cannot be null'); + throw new \InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -375,11 +388,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -390,8 +403,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -404,9 +419,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -414,15 +431,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -448,3 +465,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/UnclaimedDraftEditAndResendRequest.php b/sdks/php/src/Model/UnclaimedDraftEditAndResendRequest.php index 5669e4848..38704f677 100644 --- a/sdks/php/src/Model/UnclaimedDraftEditAndResendRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftEditAndResendRequest.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,35 +29,34 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * UnclaimedDraftEditAndResendRequest Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftEditAndResendRequest implements ModelInterface, ArrayAccess, JsonSerializable +class UnclaimedDraftEditAndResendRequest implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftEditAndResendRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'editor_options' => '\Dropbox\Sign\Model\SubEditorOptions', @@ -64,16 +65,16 @@ class UnclaimedDraftEditAndResendRequest implements ModelInterface, ArrayAccess, 'requesting_redirect_url' => 'string', 'show_progress_stepper' => 'bool', 'signing_redirect_url' => 'string', - 'test_mode' => 'bool', + 'test_mode' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'editor_options' => null, @@ -82,14 +83,14 @@ class UnclaimedDraftEditAndResendRequest implements ModelInterface, ArrayAccess, 'requesting_redirect_url' => null, 'show_progress_stepper' => null, 'signing_redirect_url' => null, - 'test_mode' => null, + 'test_mode' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'editor_options' => false, @@ -98,14 +99,14 @@ class UnclaimedDraftEditAndResendRequest implements ModelInterface, ArrayAccess, 'requesting_redirect_url' => false, 'show_progress_stepper' => false, 'signing_redirect_url' => false, - 'test_mode' => false, + 'test_mode' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -130,6 +131,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -139,7 +142,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -149,7 +152,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -158,6 +161,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -166,6 +172,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -186,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'requesting_redirect_url' => 'requesting_redirect_url', 'show_progress_stepper' => 'show_progress_stepper', 'signing_redirect_url' => 'signing_redirect_url', - 'test_mode' => 'test_mode', + 'test_mode' => 'test_mode' ]; /** @@ -202,7 +211,7 @@ public function isNullableSetToNull(string $property): bool 'requesting_redirect_url' => 'setRequestingRedirectUrl', 'show_progress_stepper' => 'setShowProgressStepper', 'signing_redirect_url' => 'setSigningRedirectUrl', - 'test_mode' => 'setTestMode', + 'test_mode' => 'setTestMode' ]; /** @@ -218,7 +227,7 @@ public function isNullableSetToNull(string $property): bool 'requesting_redirect_url' => 'getRequestingRedirectUrl', 'show_progress_stepper' => 'getShowProgressStepper', 'signing_redirect_url' => 'getSigningRedirectUrl', - 'test_mode' => 'getTestMode', + 'test_mode' => 'getTestMode' ]; /** @@ -262,6 +271,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -287,33 +297,34 @@ public function __construct(array $data = null) $this->setIfExists('test_mode', $data ?? [], false); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): UnclaimedDraftEditAndResendRequest { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): UnclaimedDraftEditAndResendRequest { /** @var UnclaimedDraftEditAndResendRequest */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, UnclaimedDraftEditAndResendRequest::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -349,6 +360,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets client_id * @@ -366,10 +378,10 @@ public function getClientId() * * @return self */ - public function setClientId(string $client_id) + public function setClientId($client_id) { if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); + throw new \InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -379,7 +391,7 @@ public function setClientId(string $client_id) /** * Gets editor_options * - * @return SubEditorOptions|null + * @return \Dropbox\Sign\Model\SubEditorOptions|null */ public function getEditorOptions() { @@ -389,14 +401,14 @@ public function getEditorOptions() /** * Sets editor_options * - * @param SubEditorOptions|null $editor_options editor_options + * @param \Dropbox\Sign\Model\SubEditorOptions|null $editor_options editor_options * * @return self */ - public function setEditorOptions(?SubEditorOptions $editor_options) + public function setEditorOptions($editor_options) { if (is_null($editor_options)) { - throw new InvalidArgumentException('non-nullable editor_options cannot be null'); + throw new \InvalidArgumentException('non-nullable editor_options cannot be null'); } $this->container['editor_options'] = $editor_options; @@ -416,14 +428,14 @@ public function getIsForEmbeddedSigning() /** * Sets is_for_embedded_signing * - * @param bool|null $is_for_embedded_signing the request created from this draft will also be signable in embedded mode if set to `true` + * @param bool|null $is_for_embedded_signing The request created from this draft will also be signable in embedded mode if set to `true`. * * @return self */ - public function setIsForEmbeddedSigning(?bool $is_for_embedded_signing) + public function setIsForEmbeddedSigning($is_for_embedded_signing) { if (is_null($is_for_embedded_signing)) { - throw new InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); + throw new \InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); } $this->container['is_for_embedded_signing'] = $is_for_embedded_signing; @@ -447,10 +459,10 @@ public function getRequesterEmailAddress() * * @return self */ - public function setRequesterEmailAddress(?string $requester_email_address) + public function setRequesterEmailAddress($requester_email_address) { if (is_null($requester_email_address)) { - throw new InvalidArgumentException('non-nullable requester_email_address cannot be null'); + throw new \InvalidArgumentException('non-nullable requester_email_address cannot be null'); } $this->container['requester_email_address'] = $requester_email_address; @@ -470,14 +482,14 @@ public function getRequestingRedirectUrl() /** * Sets requesting_redirect_url * - * @param string|null $requesting_redirect_url the URL you want signers redirected to after they successfully request a signature + * @param string|null $requesting_redirect_url The URL you want signers redirected to after they successfully request a signature. * * @return self */ - public function setRequestingRedirectUrl(?string $requesting_redirect_url) + public function setRequestingRedirectUrl($requesting_redirect_url) { if (is_null($requesting_redirect_url)) { - throw new InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); } $this->container['requesting_redirect_url'] = $requesting_redirect_url; @@ -497,14 +509,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden + * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. * * @return self */ - public function setShowProgressStepper(?bool $show_progress_stepper) + public function setShowProgressStepper($show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -524,14 +536,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -555,22 +567,23 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -579,11 +592,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -594,8 +607,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -608,9 +623,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -618,15 +635,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -652,3 +669,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/UnclaimedDraftResponse.php b/sdks/php/src/Model/UnclaimedDraftResponse.php index da1c26359..b50d57465 100644 --- a/sdks/php/src/Model/UnclaimedDraftResponse.php +++ b/sdks/php/src/Model/UnclaimedDraftResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,80 +29,79 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * UnclaimedDraftResponse Class Doc Comment * * @category Class * @description A group of documents that a user can take ownership of via the claim URL. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftResponse implements ModelInterface, ArrayAccess, JsonSerializable +class UnclaimedDraftResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'signature_request_id' => 'string', 'claim_url' => 'string', 'signing_redirect_url' => 'string', 'requesting_redirect_url' => 'string', 'expires_at' => 'int', - 'test_mode' => 'bool', + 'test_mode' => 'bool' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'signature_request_id' => null, 'claim_url' => null, 'signing_redirect_url' => null, 'requesting_redirect_url' => null, 'expires_at' => null, - 'test_mode' => null, + 'test_mode' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'signature_request_id' => true, 'claim_url' => false, 'signing_redirect_url' => true, 'requesting_redirect_url' => true, 'expires_at' => true, - 'test_mode' => false, + 'test_mode' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -125,6 +126,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -134,7 +137,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -144,7 +147,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -153,6 +156,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -161,6 +167,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +188,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'signing_redirect_url', 'requesting_redirect_url' => 'requesting_redirect_url', 'expires_at' => 'expires_at', - 'test_mode' => 'test_mode', + 'test_mode' => 'test_mode' ]; /** @@ -193,7 +202,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'setSigningRedirectUrl', 'requesting_redirect_url' => 'setRequestingRedirectUrl', 'expires_at' => 'setExpiresAt', - 'test_mode' => 'setTestMode', + 'test_mode' => 'setTestMode' ]; /** @@ -207,7 +216,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'getSigningRedirectUrl', 'requesting_redirect_url' => 'getRequestingRedirectUrl', 'expires_at' => 'getExpiresAt', - 'test_mode' => 'getTestMode', + 'test_mode' => 'getTestMode' ]; /** @@ -251,6 +260,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -274,33 +284,34 @@ public function __construct(array $data = null) $this->setIfExists('test_mode', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): UnclaimedDraftResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): UnclaimedDraftResponse { /** @var UnclaimedDraftResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, UnclaimedDraftResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -317,7 +328,9 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + return $invalidProperties; } /** @@ -331,6 +344,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets signature_request_id * @@ -344,18 +358,18 @@ public function getSignatureRequestId() /** * Sets signature_request_id * - * @param string|null $signature_request_id the ID of the signature request that is represented by this UnclaimedDraft + * @param string|null $signature_request_id The ID of the signature request that is represented by this UnclaimedDraft. * * @return self */ - public function setSignatureRequestId(?string $signature_request_id) + public function setSignatureRequestId($signature_request_id) { if (is_null($signature_request_id)) { array_push($this->openAPINullablesSetToNull, 'signature_request_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signature_request_id', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -378,14 +392,14 @@ public function getClaimUrl() /** * Sets claim_url * - * @param string|null $claim_url the URL to be used to claim this UnclaimedDraft + * @param string|null $claim_url The URL to be used to claim this UnclaimedDraft. * * @return self */ - public function setClaimUrl(?string $claim_url) + public function setClaimUrl($claim_url) { if (is_null($claim_url)) { - throw new InvalidArgumentException('non-nullable claim_url cannot be null'); + throw new \InvalidArgumentException('non-nullable claim_url cannot be null'); } $this->container['claim_url'] = $claim_url; @@ -405,18 +419,18 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. * * @return self */ - public function setSigningRedirectUrl(?string $signing_redirect_url) + public function setSigningRedirectUrl($signing_redirect_url) { if (is_null($signing_redirect_url)) { array_push($this->openAPINullablesSetToNull, 'signing_redirect_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signing_redirect_url', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -443,14 +457,14 @@ public function getRequestingRedirectUrl() * * @return self */ - public function setRequestingRedirectUrl(?string $requesting_redirect_url) + public function setRequestingRedirectUrl($requesting_redirect_url) { if (is_null($requesting_redirect_url)) { array_push($this->openAPINullablesSetToNull, 'requesting_redirect_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('requesting_redirect_url', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -473,18 +487,18 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at when the link expires + * @param int|null $expires_at When the link expires. * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt($expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== false) { + if ($index !== FALSE) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -511,22 +525,23 @@ public function getTestMode() * * @return self */ - public function setTestMode(?bool $test_mode) + public function setTestMode($test_mode) { if (is_null($test_mode)) { - throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -535,11 +550,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -550,8 +565,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -564,9 +581,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -574,15 +593,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -608,3 +627,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/Model/WarningResponse.php b/sdks/php/src/Model/WarningResponse.php index 4c37010a0..f8b97f736 100644 --- a/sdks/php/src/Model/WarningResponse.php +++ b/sdks/php/src/Model/WarningResponse.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,68 +29,67 @@ namespace Dropbox\Sign\Model; -use ArrayAccess; -use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; -use JsonSerializable; -use ReturnTypeWillChange; +use \ArrayAccess; +use \Dropbox\Sign\ObjectSerializer; /** * WarningResponse Class Doc Comment * * @category Class * @description A list of warnings. - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech * @implements \ArrayAccess */ -class WarningResponse implements ModelInterface, ArrayAccess, JsonSerializable +class WarningResponse implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'WarningResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'warning_msg' => 'string', - 'warning_name' => 'string', + 'warning_name' => 'string' ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'warning_msg' => null, - 'warning_name' => null, + 'warning_name' => null ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var bool[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var boolean[] + */ protected static array $openAPINullables = [ 'warning_msg' => false, - 'warning_name' => false, + 'warning_name' => false ]; /** - * If a nullable field gets set to null, insert it here - * - * @var bool[] - */ + * If a nullable field gets set to null, insert it here + * + * @var boolean[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,6 +114,8 @@ public static function openAPIFormats() /** * Array of nullable properties + * + * @return array */ protected static function openAPINullables(): array { @@ -122,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return bool[] + * @return boolean[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param bool[] $openAPINullablesSetToNull + * @param boolean[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,6 +144,9 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable + * + * @param string $property + * @return bool */ public static function isNullable(string $property): bool { @@ -149,6 +155,9 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. + * + * @param string $property + * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -163,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'warning_msg' => 'warning_msg', - 'warning_name' => 'warning_name', + 'warning_name' => 'warning_name' ]; /** @@ -173,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'warning_msg' => 'setWarningMsg', - 'warning_name' => 'setWarningName', + 'warning_name' => 'setWarningName' ]; /** @@ -183,7 +192,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'warning_msg' => 'getWarningMsg', - 'warning_name' => 'getWarningName', + 'warning_name' => 'getWarningName' ]; /** @@ -227,6 +236,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -246,33 +256,34 @@ public function __construct(array $data = null) $this->setIfExists('warning_name', $data ?? [], null); } - /** - * @deprecated use ::init() - */ + /** @deprecated use ::init() */ public static function fromArray(array $data): WarningResponse { return self::init($data); } - /** - * Attempt to instantiate and hydrate a new instance of this class - */ + /** Attempt to instantiate and hydrate a new instance of this class */ public static function init(array $data): WarningResponse { /** @var WarningResponse */ - return ObjectSerializer::deserialize( + $obj = ObjectSerializer::deserialize( $data, WarningResponse::class, ); + + return $obj; } + /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string $variableName + * @param array $fields +* @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -311,6 +322,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets warning_msg * @@ -328,10 +340,10 @@ public function getWarningMsg() * * @return self */ - public function setWarningMsg(string $warning_msg) + public function setWarningMsg($warning_msg) { if (is_null($warning_msg)) { - throw new InvalidArgumentException('non-nullable warning_msg cannot be null'); + throw new \InvalidArgumentException('non-nullable warning_msg cannot be null'); } $this->container['warning_msg'] = $warning_msg; @@ -355,22 +367,23 @@ public function getWarningName() * * @return self */ - public function setWarningName(string $warning_name) + public function setWarningName($warning_name) { if (is_null($warning_name)) { - throw new InvalidArgumentException('non-nullable warning_name cannot be null'); + throw new \InvalidArgumentException('non-nullable warning_name cannot be null'); } $this->container['warning_name'] = $warning_name; return $this; } - /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return boolean */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -379,11 +392,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -394,8 +407,10 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -408,9 +423,11 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset + * + * @return void */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -418,15 +435,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ - #[ReturnTypeWillChange] + #[\ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -452,3 +469,5 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } + + diff --git a/sdks/php/src/ObjectSerializer.php b/sdks/php/src/ObjectSerializer.php index 958cd8e04..25c1ba9ff 100644 --- a/sdks/php/src/ObjectSerializer.php +++ b/sdks/php/src/ObjectSerializer.php @@ -5,7 +5,9 @@ * PHP version 7.4 * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ /** @@ -27,31 +29,29 @@ namespace Dropbox\Sign; -use DateTime; +use GuzzleHttp\Psr7\Utils; use Dropbox\Sign\Model\ModelInterface; -use Exception; use GuzzleHttp; -use GuzzleHttp\Psr7\Utils; -use InvalidArgumentException; -use SplFileObject; /** * ObjectSerializer Class Doc Comment * * @category Class - * @see https://openapi-generator.tech + * @package Dropbox\Sign + * @author OpenAPI Generator team + * @link https://openapi-generator.tech */ class ObjectSerializer { /** @var string */ - private static $dateTimeFormat = DateTime::ATOM; + private static $dateTimeFormat = \DateTime::ATOM; /** * Change the date format * - * @param string $format the new date format to use + * @param string $format the new date format to use */ - public static function setDateTimeFormat(string $format) + public static function setDateTimeFormat($format) { self::$dateTimeFormat = $format; } @@ -59,19 +59,19 @@ public static function setDateTimeFormat(string $format) /** * Serialize data * - * @param string|int|object|array|mixed $data the data to serialize - * @param string $type the OpenAPIToolsType of the data - * @param string $format the format of the OpenAPITools type of the data + * @param string|int|object|array|mixed $data the data to serialize + * @param string $type the OpenAPIToolsType of the data + * @param string $format the format of the OpenAPITools type of the data * * @return scalar|object|array|null serialized form of $data */ - public static function sanitizeForSerialization($data, string $type = null, string $format = null) + public static function sanitizeForSerialization($data, $type = null, $format = null) { if (is_scalar($data) || null === $data) { return $data; } - if ($data instanceof DateTime) { + if ($data instanceof \DateTime) { return ($format === 'date') ? $data->format('Y-m-d') : $data->format(self::$dateTimeFormat); } @@ -88,7 +88,7 @@ public static function sanitizeForSerialization($data, string $type = null, stri $formats = $data::openAPIFormats(); foreach ($data::openAPITypes() as $property => $openAPIType) { $getter = $data::getters()[$property]; - $value = $data->{$getter}(); + $value = $data->$getter(); if ($value !== null && !in_array($openAPIType, ['\DateTime', '\SplFileObject', 'array', 'bool', 'boolean', 'byte', 'float', 'int', 'integer', 'mixed', 'number', 'object', 'string', 'void'], true)) { $callable = [$openAPIType, 'getAllowableEnumValues']; if (is_callable($callable)) { @@ -96,7 +96,7 @@ public static function sanitizeForSerialization($data, string $type = null, stri $allowedEnumTypes = $callable(); if (!in_array($value, $allowedEnumTypes, true)) { $imploded = implode("', '", $allowedEnumTypes); - throw new InvalidArgumentException("Invalid value for enum '{$openAPIType}', must be one of: '{$imploded}'"); + throw new \InvalidArgumentException("Invalid value for enum '$openAPIType', must be one of: '$imploded'"); } } } @@ -104,16 +104,17 @@ public static function sanitizeForSerialization($data, string $type = null, stri $values[$data::attributeMap()[$property]] = self::sanitizeForSerialization($value, $openAPIType, $formats[$property]); } } - } elseif ($data instanceof SplFileObject) { - return (string)$data; + } else if ($data instanceof \SplFileObject) { + return (string) $data; } else { - foreach ($data as $property => $value) { + foreach($data as $property => $value) { $values[$property] = self::sanitizeForSerialization($value); } } return (object)$values; + } else { + return (string)$data; } - return (string)$data; } /** @@ -124,12 +125,13 @@ public static function sanitizeForSerialization($data, string $type = null, stri * * @return string the sanitized filename */ - public static function sanitizeFilename(string $filename) + public static function sanitizeFilename($filename) { - if (preg_match('/.*[\\/\\\\](.*)$/', $filename, $match)) { + if (preg_match("/.*[\/\\\\](.*)$/", $filename, $match)) { return $match[1]; + } else { + return $filename; } - return $filename; } /** @@ -139,11 +141,9 @@ public static function sanitizeFilename(string $filename) * * @return string the shorten timestamp */ - public static function sanitizeTimestamp(string $timestamp) + public static function sanitizeTimestamp($timestamp) { - if (!is_string($timestamp)) { - return $timestamp; - } + if (!is_string($timestamp)) return $timestamp; return preg_replace('/(:\d{2}.\d{6})\d*/', '$1', $timestamp); } @@ -156,7 +156,7 @@ public static function sanitizeTimestamp(string $timestamp) * * @return string the serialized object */ - public static function toPathValue(string $value) + public static function toPathValue($value) { return rawurlencode(self::toString($value)); } @@ -164,26 +164,27 @@ public static function toPathValue(string $value) /** * Checks if a value is empty, based on its OpenAPI type. * - * @param string|int|object|array|mixed $value + * @param string|int|object|array|mixed $value + * @param string $openApiType * * @return bool true if $value is empty */ private static function isEmptyValue($value, string $openApiType): bool { - // If empty() returns false, it is not empty regardless of its type. + # If empty() returns false, it is not empty regardless of its type. if (!empty($value)) { return false; } - // Null is always empty, as we cannot send a real "null" value in a query parameter. + # Null is always empty, as we cannot send a real "null" value in a query parameter. if ($value === null) { return true; } switch ($openApiType) { - // For numeric values, false and '' are considered empty. - // This comparison is safe for floating point values, since the previous call to empty() will - // filter out values that don't match 0. + # For numeric values, false and '' are considered empty. + # This comparison is safe for floating point values, since the previous call to empty() will + # filter out values that don't match 0. case 'int': case 'integer': return $value !== 0; @@ -192,12 +193,12 @@ private static function isEmptyValue($value, string $openApiType): bool case 'float': return $value !== 0 && $value !== 0.0; - // For boolean values, '' is considered empty + # For boolean values, '' is considered empty case 'bool': case 'boolean': return !in_array($value, [false, 0], true); - // For all the other types, any value at this point can be considered empty. + # For all the other types, any value at this point can be considered empty. default: return true; } @@ -207,12 +208,14 @@ private static function isEmptyValue($value, string $openApiType): bool * Take query parameter properties and turn it into an array suitable for * native http_build_query or GuzzleHttp\Psr7\Query::build. * - * @param string|int|object|array|mixed $value Parameter value - * @param string $paramName Parameter name - * @param string $openApiType OpenAPIType eg. array or object - * @param string $style Parameter serialization style - * @param bool $explode Parameter explode option - * @param bool $required Whether query param is required or not + * @param string|int|object|array|mixed $value Parameter value + * @param string $paramName Parameter name + * @param string $openApiType OpenAPIType eg. array or object + * @param string $style Parameter serialization style + * @param bool $explode Parameter explode option + * @param bool $required Whether query param is required or not + * + * @return array */ public static function toQueryValue( $value, @@ -222,19 +225,21 @@ public static function toQueryValue( bool $explode = true, bool $required = true ): array { - // Check if we should omit this parameter from the query. This should only happen when: - // - Parameter is NOT required; AND - // - its value is set to a value that is equivalent to "empty", depending on its OpenAPI type. For - // example, 0 as "int" or "boolean" is NOT an empty value. + + # Check if we should omit this parameter from the query. This should only happen when: + # - Parameter is NOT required; AND + # - its value is set to a value that is equivalent to "empty", depending on its OpenAPI type. For + # example, 0 as "int" or "boolean" is NOT an empty value. if (self::isEmptyValue($value, $openApiType)) { if ($required) { return ["{$paramName}" => '']; + } else { + return []; } - return []; } - // Handle DateTime objects in query - if ($openApiType === '\\DateTime' && $value instanceof DateTime) { + # Handle DateTime objects in query + if($openApiType === "\\DateTime" && $value instanceof \DateTime) { return ["{$paramName}" => $value->format(self::$dateTimeFormat)]; } @@ -244,9 +249,7 @@ public static function toQueryValue( // since \GuzzleHttp\Psr7\Query::build fails with nested arrays // need to flatten array first $flattenArray = function ($arr, $name, &$result = []) use (&$flattenArray, $style, $explode) { - if (!is_array($arr)) { - return $arr; - } + if (!is_array($arr)) return $arr; foreach ($arr as $k => $v) { $prop = ($style === 'deepObject') ? $prop = "{$name}[{$k}]" : $k; @@ -298,7 +301,7 @@ public static function convertBoolToQueryStringFormat(bool $value) return $value ? 'true' : 'false'; } - return (int)$value; + return (int) $value; } /** @@ -310,7 +313,7 @@ public static function convertBoolToQueryStringFormat(bool $value) * * @return string the header string */ - public static function toHeaderValue(string $value) + public static function toHeaderValue($value) { $callable = [$value, 'toHeaderValue']; if (is_callable($callable)) { @@ -325,16 +328,17 @@ public static function toHeaderValue(string $value) * the http body (form parameter). If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 * - * @param string|SplFileObject $value the value of the form parameter + * @param string|\SplFileObject $value the value of the form parameter * * @return string the form string */ public static function toFormValue($value) { - if ($value instanceof SplFileObject) { + if ($value instanceof \SplFileObject) { return $value->getRealPath(); + } else { + return self::toString($value); } - return self::toString($value); } /** @@ -349,13 +353,13 @@ public static function toFormValue($value) */ public static function toString($value) { - if ($value instanceof DateTime) { // datetime in ISO8601 format + if ($value instanceof \DateTime) { // datetime in ISO8601 format return $value->format(self::$dateTimeFormat); - } - if (is_bool($value)) { + } elseif (is_bool($value)) { return $value ? 'true' : 'false'; + } else { + return (string) $value; } - return (string)$value; } /** @@ -363,12 +367,12 @@ public static function toString($value) * * @param array $collection collection to serialize to a string * @param string $style the format use for serialization (csv, - * ssv, tsv, pipes, multi) + * ssv, tsv, pipes, multi) * @param bool $allowCollectionFormatMulti allow collection format to be a multidimensional array * * @return string */ - public static function serializeCollection(array $collection, string $style, bool $allowCollectionFormatMulti = false) + public static function serializeCollection(array $collection, $style, $allowCollectionFormatMulti = false) { if ($allowCollectionFormatMulti && ('multi' === $style)) { // http_build_query() almost does the job for us. We just @@ -398,13 +402,13 @@ public static function serializeCollection(array $collection, string $style, boo /** * Deserialize a JSON string into an object * - * @param string|int|object|array|mixed $data object or primitive to be deserialized - * @param string $class class name is passed as a string - * @param string[] $httpHeaders HTTP headers + * @param string|int|object|array|mixed $data object or primitive to be deserialized + * @param string $class class name is passed as a string + * @param string[] $httpHeaders HTTP headers * * @return object|array|null a single or an array of $class instances */ - public static function deserialize($data, string $class, array $httpHeaders = null) + public static function deserialize($data, $class, $httpHeaders = null) { if (null === $data) { return null; @@ -414,7 +418,7 @@ public static function deserialize($data, string $class, array $httpHeaders = nu $data = is_string($data) ? json_decode($data) : $data; if (!is_array($data)) { - throw new InvalidArgumentException("Invalid array '{$class}'"); + throw new \InvalidArgumentException("Invalid array '$class'"); } $subClass = substr($class, 0, -2); @@ -430,7 +434,7 @@ public static function deserialize($data, string $class, array $httpHeaders = nu settype($data, 'array'); $inner = substr($class, 4, -1); $deserialized = []; - if (strrpos($inner, ',') !== false) { + if (strrpos($inner, ",") !== false) { $subClass_array = explode(',', $inner, 2); $subClass = $subClass_array[1]; foreach ($data as $key => $value) { @@ -443,8 +447,7 @@ public static function deserialize($data, string $class, array $httpHeaders = nu if ($class === 'object') { settype($data, 'array'); return $data; - } - if ($class === 'mixed') { + } elseif ($class === 'mixed') { settype($data, gettype($data)); return $data; } @@ -458,12 +461,12 @@ public static function deserialize($data, string $class, array $httpHeaders = nu // this graceful. if (!empty($data)) { try { - return new DateTime($data); - } catch (Exception $exception) { + return new \DateTime($data); + } catch (\Exception $exception) { // Some APIs return a date-time with too high nanosecond // precision for php's DateTime to handle. // With provided regexp 6 digits of microseconds saved - return new DateTime(self::sanitizeTimestamp($data)); + return new \DateTime(self::sanitizeTimestamp($data)); } } else { return null; @@ -471,7 +474,7 @@ public static function deserialize($data, string $class, array $httpHeaders = nu } if ($class === '\SplFileObject') { - if (is_a($data, SplFileObject::class)) { + if (is_a($data, \SplFileObject::class)) { return $data; } @@ -496,7 +499,7 @@ public static function deserialize($data, string $class, array $httpHeaders = nu } fclose($file); - return new SplFileObject($filename, 'r'); + return new \SplFileObject($filename, 'r'); } /** @psalm-suppress ParadoxicalCondition */ @@ -505,95 +508,97 @@ public static function deserialize($data, string $class, array $httpHeaders = nu return $data; } + if (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}'"); + throw new \InvalidArgumentException("Invalid value for enum '$class', must be one of: '$imploded'"); } return $data; - } - $data = is_string($data) ? json_decode($data) : $data; - - if (is_array($data)) { - $data = (object)$data; - } + } else { + $data = is_string($data) ? json_decode($data) : $data; - // If a discriminator is defined and points to a valid subclass, use it. - $discriminator = $class::DISCRIMINATOR; - $discriminatorValue = null; - if (is_object($data)) { - $discriminatorValue = $data->{$discriminator} ?? null; - } elseif (is_array($data)) { - $discriminatorValue = $data[$discriminator] ?? null; - } + if (is_array($data)) { + $data = (object)$data; + } - $discrimnatorSubclassFound = false; - if (!empty($discriminator) && isset($data->{$discriminator}) && is_string($data->{$discriminator})) { - $subclass = '\Dropbox\Sign\Model\\' . $data->{$discriminator}; - if (is_subclass_of($subclass, $class)) { - $class = $subclass; - $discrimnatorSubclassFound = true; + // If a discriminator is defined and points to a valid subclass, use it. + $discriminator = $class::DISCRIMINATOR; + $discriminatorValue = null; + if (is_object($data)) { + $discriminatorValue = $data->{$discriminator} ?? null; + } elseif (is_array($data)) { + $discriminatorValue = $data[$discriminator] ?? null; } - } - if ( - !$discrimnatorSubclassFound - && !empty($discriminator) - && method_exists($class, 'discriminatorClassName') - ) { - $subclass = call_user_func( - "{$class}::discriminatorClassName", - (array)$data, - ); - - if (empty($subclass)) { - return null; + $discrimnatorSubclassFound = false; + if (!empty($discriminator) && isset($data->{$discriminator}) && is_string($data->{$discriminator})) { + $subclass = '\Dropbox\Sign\Model\\' . $data->{$discriminator}; + if (is_subclass_of($subclass, $class)) { + $class = $subclass; + $discrimnatorSubclassFound = true; + } } - $class = $subclass; - $discrimnatorSubclassFound = true; - } + if ( + !$discrimnatorSubclassFound + && !empty($discriminator) + && method_exists($class, 'discriminatorClassName') + ) { + $subclass = call_user_func( + "{$class}::discriminatorClassName", + (array) $data, + ); - /** @var ModelInterface $instance */ - $instance = new $class(); - foreach ($instance::openAPITypes() as $property => $type) { - $propertySetter = $instance::setters()[$property]; + if (empty($subclass)) { + return null; + } - if (!isset($propertySetter)) { - continue; + $class = $subclass; + $discrimnatorSubclassFound = true; } - if (!isset($data->{$instance::attributeMap()[$property]})) { - if ($instance::isNullable($property)) { - $instance->{$propertySetter}(null); + /** @var ModelInterface $instance */ + $instance = new $class(); + foreach ($instance::openAPITypes() as $property => $type) { + $propertySetter = $instance::setters()[$property]; + + if (!isset($propertySetter)) { + continue; } - continue; - } + if (!isset($data->{$instance::attributeMap()[$property]})) { + if ($instance::isNullable($property)) { + $instance->$propertySetter(null); + } + + continue; + } - if (isset($data->{$instance::attributeMap()[$property]})) { - $propertyValue = $data->{$instance::attributeMap()[$property]}; - $instance->{$propertySetter}(self::deserialize($propertyValue, $type, null)); + if (isset($data->{$instance::attributeMap()[$property]})) { + $propertyValue = $data->{$instance::attributeMap()[$property]}; + $instance->$propertySetter(self::deserialize($propertyValue, $type, null)); + } } + return $instance; } - return $instance; } /** - * Build a query string from an array of key value pairs. - * - * This function can use the return value of `parse()` to build a query - * string. This function does not modify the provided keys when an array is - * encountered (like `http_build_query()` would). - * - * The function is copied from https://github.com/guzzle/psr7/blob/a243f80a1ca7fe8ceed4deee17f12c1930efe662/src/Query.php#L59-L112 - * with a modification which is described in https://github.com/guzzle/psr7/pull/603 - * - * @param array $params query string parameters - * @param int|false $encoding set to false to not encode, PHP_QUERY_RFC3986 - * to encode using RFC3986, or PHP_QUERY_RFC1738 - * to encode using RFC1738 - */ + * Build a query string from an array of key value pairs. + * + * This function can use the return value of `parse()` to build a query + * string. This function does not modify the provided keys when an array is + * encountered (like `http_build_query()` would). + * + * The function is copied from https://github.com/guzzle/psr7/blob/a243f80a1ca7fe8ceed4deee17f12c1930efe662/src/Query.php#L59-L112 + * with a modification which is described in https://github.com/guzzle/psr7/pull/603 + * + * @param array $params Query string parameters. + * @param int|false $encoding Set to false to not encode, PHP_QUERY_RFC3986 + * to encode using RFC3986, or PHP_QUERY_RFC1738 + * to encode using RFC1738. + */ public static function buildQuery(array $params, $encoding = PHP_QUERY_RFC3986): string { if (!$params) { @@ -609,21 +614,21 @@ public static function buildQuery(array $params, $encoding = PHP_QUERY_RFC3986): } elseif ($encoding === PHP_QUERY_RFC1738) { $encoder = 'urlencode'; } else { - throw new InvalidArgumentException('Invalid type'); + throw new \InvalidArgumentException('Invalid type'); } $castBool = Configuration::BOOLEAN_FORMAT_INT == Configuration::getDefaultConfiguration()->getBooleanFormatForQueryString() - ? function ($v) { return (int)$v; } - : function ($v) { return $v ? 'true' : 'false'; }; + ? function ($v) { return (int) $v; } + : function ($v) { return $v ? 'true' : 'false'; }; $qs = ''; foreach ($params as $k => $v) { - $k = $encoder((string)$k); + $k = $encoder((string) $k); if (!is_array($v)) { $qs .= $k; $v = is_bool($v) ? $castBool($v) : $v; if ($v !== null) { - $qs .= '=' . $encoder((string)$v); + $qs .= '='.$encoder((string) $v); } $qs .= '&'; } else { @@ -631,14 +636,14 @@ public static function buildQuery(array $params, $encoding = PHP_QUERY_RFC3986): $qs .= $k; $vv = is_bool($vv) ? $castBool($vv) : $vv; if ($vv !== null) { - $qs .= '=' . $encoder((string)$vv); + $qs .= '='.$encoder((string) $vv); } $qs .= '&'; } } } - return $qs ? (string)substr($qs, 0, -1) : ''; + return $qs ? (string) substr($qs, 0, -1) : ''; } /** diff --git a/translations/en.yaml b/translations/en.yaml index 52a9b3559..e6ee3186d 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -131,26 +131,34 @@ "EmbeddedSignUrl::SIGNATURE_ID": The id of the signature to get a signature url for. "FaxGet::SUMMARY": Get Fax -"FaxGet::DESCRIPTION": Returns information about fax +"FaxGet::DESCRIPTION": Returns information about a Fax "FaxParam::FAX_ID": Fax ID "FaxDelete::SUMMARY": Delete Fax -"FaxDelete::DESCRIPTION": Deletes the specified Fax from the system. +"FaxDelete::DESCRIPTION": Deletes the specified Fax from the system "FaxFiles::SUMMARY": Download Fax Files -"FaxFiles::DESCRIPTION": Downloads fax files +"FaxFiles::DESCRIPTION": Downloads files associated with a Fax "FaxList::SUMMARY": Lists Faxes -"FaxList::DESCRIPTION": Returns properties of multiple faxes -"FaxList::PAGE": Page -"FaxList::PAGE_SIZE": Page size +"FaxList::DESCRIPTION": Returns properties of multiple Faxes +"FaxList::PAGE": Which page number of the Fax List to return. Defaults to `1`. +"FaxList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. "FaxSend::SUMMARY": Send Fax -"FaxSend::DESCRIPTION": Action to prepare and send a fax -"FaxSend::RECIPIENT": Fax Send To Recipient +"FaxSend::DESCRIPTION": Creates and sends a new Fax with the submitted file(s) +"FaxSend::RECIPIENT": |- + Recipient of the fax + Can be a phone number in E.164 format or email address "FaxSend::SENDER": Fax Send From Sender (used only with fax number) -"FaxSend::FILE": Fax File to Send -"FaxSend::FILE_URL": Fax File URL to Send +"FaxSend::FILE": |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. +"FaxSend::FILE_URL": |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. "FaxSend::FILE_URL_NAMES": Fax File URL Names "FaxSend::TEST_MODE": API Test Mode Setting -"FaxSend::COVER_PAGE_TO": Fax Cover Page for Recipient -"FaxSend::COVER_PAGE_FROM": Fax Cover Page for Sender +"FaxSend::COVER_PAGE_TO": Fax cover page recipient information +"FaxSend::COVER_PAGE_FROM": Fax cover page sender information "FaxSend::COVER_PAGE_MESSAGE": Fax Cover Page Message "FaxSend::TITLE": Fax Title "FaxGetResponseExample::SUMMARY": Fax Response @@ -168,41 +176,41 @@ "Sub::FaxResponseTransmission::RECIPIENT": Fax Transmission Recipient "Sub::FaxResponseTransmission::STATUS_CODE": Fax Transmission Status Code "Sub::FaxResponseTransmission::SENT_AT": Fax Transmission Sent Timestamp -"FaxListResponseExample::SUMMARY": Returns the properties and settings of multiple Faxes. +"FaxListResponseExample::SUMMARY": Returns the properties and settings of multiple Faxes "FaxLineAddUser::SUMMARY": Add Fax Line User "FaxLineAddUser::DESCRIPTION": Grants a user access to the specified Fax Line. -"FaxLineAddUser::NUMBER": The Fax Line number. +"FaxLineAddUser::NUMBER": The Fax Line number "FaxLineAddUser::ACCOUNT_ID": Account ID "FaxLineAddUser::EMAIL_ADDRESS": Email address "FaxLineAreaCodeGet::SUMMARY": Get Available Fax Line Area Codes -"FaxLineAreaCodeGet::DESCRIPTION": Returns a response with the area codes available for a given state/province and city. -"FaxLineAreaCodeGet::CITY": Filter area codes by city. -"FaxLineAreaCodeGet::STATE": Filter area codes by state. -"FaxLineAreaCodeGet::PROVINCE": Filter area codes by province. -"FaxLineAreaCodeGet::COUNTRY": Filter area codes by country. +"FaxLineAreaCodeGet::DESCRIPTION": Returns a list of available area codes for a given state/province and city +"FaxLineAreaCodeGet::CITY": Filter area codes by city +"FaxLineAreaCodeGet::STATE": Filter area codes by state +"FaxLineAreaCodeGet::PROVINCE": Filter area codes by province +"FaxLineAreaCodeGet::COUNTRY": Filter area codes by country "FaxLineCreate::SUMMARY": Purchase Fax Line -"FaxLineCreate::DESCRIPTION": Purchases a new Fax Line. +"FaxLineCreate::DESCRIPTION": Purchases a new Fax Line "FaxLineDelete::SUMMARY": Delete Fax Line "FaxLineDelete::DESCRIPTION": Deletes the specified Fax Line from the subscription. "FaxLineGet::SUMMARY": Get Fax Line "FaxLineGet::DESCRIPTION": Returns the properties and settings of a Fax Line. -"FaxLineGet::NUMBER": The Fax Line number. +"FaxLineGet::NUMBER": The Fax Line number "FaxLineList::SUMMARY": List Fax Lines "FaxLineList::DESCRIPTION": Returns the properties and settings of multiple Fax Lines. "FaxLineList::ACCOUNT_ID": Account ID -"FaxLineList::PAGE": Page -"FaxLineList::PAGE_SIZE": Page size -"FaxLineList::SHOW_TEAM_LINES": Show team lines +"FaxLineList::PAGE": Which page number of the Fax Line List to return. Defaults to `1`. +"FaxLineList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. +"FaxLineList::SHOW_TEAM_LINES": Include Fax Lines belonging to team members in the list "FaxLineRemoveUser::SUMMARY": Remove Fax Line Access -"FaxLineRemoveUser::DESCRIPTION": Removes a user's access to the specified Fax Line. -"FaxLineRemoveUser::NUMBER": The Fax Line number. -"FaxLineRemoveUser::ACCOUNT_ID": Account ID -"FaxLineRemoveUser::EMAIL_ADDRESS": Email address -"FaxLineCreate::AREA_CODE": Area code -"FaxLineCreate::CITY": City -"FaxLineCreate::COUNTRY": Country -"FaxLineCreate::ACCOUNT_ID": Account ID -"FaxLineDelete::NUMBER": The Fax Line number. +"FaxLineRemoveUser::DESCRIPTION": Removes a user's access to the specified Fax Line +"FaxLineRemoveUser::NUMBER": The Fax Line number +"FaxLineRemoveUser::ACCOUNT_ID": Account ID of the user to remove access +"FaxLineRemoveUser::EMAIL_ADDRESS": Email address of the user to remove access +"FaxLineCreate::AREA_CODE": Area code of the new Fax Line +"FaxLineCreate::CITY": City of the area code +"FaxLineCreate::COUNTRY": Country of the area code +"FaxLineCreate::ACCOUNT_ID": Account ID of the account that will be assigned this new Fax Line +"FaxLineDelete::NUMBER": The Fax Line number "FaxLineResponseExample::SUMMARY": Sample Fax Line Response "FaxLineAreaCodeGetResponseExample::SUMMARY": Sample Area Code Response "FaxLineListResponseExample::SUMMARY": Sample Fax Line List Response @@ -1702,25 +1710,25 @@ "EmbeddedSignUrl::SEO::TITLE": "Get Embedded Sign URL | iFrame | Dropbox Sign for Developers" "EmbeddedSignUrl::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here." "FaxGet::SEO::TITLE": "Get Fax | API Documentation | Dropbox Fax for Developers" -"FaxGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here." +"FaxGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here." "FaxDelete::SEO::TITLE": "Delete Fax | API Documentation | Dropbox Fax for Developers" "FaxDelete::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here." "FaxFiles::SEO::TITLE": "Fax Files | API Documentation | Dropbox Fax for Developers" -"FaxFiles::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here." +"FaxFiles::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here." "FaxList::SEO::TITLE": "List Faxes | API Documentation | Dropbox Fax for Developers" "FaxList::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here." -"FaxSend::SEO::TITLE": "Send Fax| API Documentation | Dropbox Fax for Developers" +"FaxSend::SEO::TITLE": "Send Fax | API Documentation | Dropbox Fax for Developers" "FaxSend::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here." "FaxLineAddUser::SEO::TITLE": "Fax Line Add User | API Documentation | Dropbox Fax for Developers" "FaxLineAddUser::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to add a user to an existing fax line, click here." "FaxLineAreaCodeGet::SEO::TITLE": "Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers" -"FaxLineAreaCodeGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here." +"FaxLineAreaCodeGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here." "FaxLineCreate::SEO::TITLE": "Purchase Fax Line | API Documentation | Dropbox Fax for Developers" "FaxLineCreate::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here." "FaxLineDelete::SEO::TITLE": "Delete Fax Line | API Documentation | Dropbox Fax for Developers" "FaxLineDelete::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here." "FaxLineGet::SEO::TITLE": "Get Fax Line | API Documentation | Dropbox Fax for Developers" -"FaxLineGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here." +"FaxLineGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here." "FaxLineList::SEO::TITLE": "List Fax Lines | API Documentation | Dropbox Fax for Developers" "FaxLineList::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here." "FaxLineRemoveUser::SEO::TITLE": "Fax Line Remove User | API Documentation | Dropbox Fax for Developers" From 51a4a3ed34e70cc9708fb293b07178c6b4939935 Mon Sep 17 00:00:00 2001 From: Jen Young Date: Mon, 3 Feb 2025 09:38:37 -0800 Subject: [PATCH 2/3] Add missing sdks --- sdks/php/README.md | 27 +- sdks/php/docs/Api/AccountApi.md | 109 +- sdks/php/docs/Api/ApiAppApi.md | 164 +- sdks/php/docs/Api/BulkSendJobApi.md | 61 +- sdks/php/docs/Api/EmbeddedApi.md | 56 +- sdks/php/docs/Api/FaxApi.md | 125 +- sdks/php/docs/Api/FaxLineApi.md | 165 +- sdks/php/docs/Api/OAuthApi.md | 45 +- sdks/php/docs/Api/ReportApi.md | 29 +- sdks/php/docs/Api/SignatureRequestApi.md | 618 +++++- sdks/php/docs/Api/TeamApi.md | 266 ++- sdks/php/docs/Api/TemplateApi.md | 363 +++- sdks/php/docs/Api/UnclaimedDraftApi.md | 163 +- sdks/php/docs/Model/AccountCreateRequest.md | 12 +- sdks/php/docs/Model/AccountCreateResponse.md | 6 +- sdks/php/docs/Model/AccountGetResponse.md | 4 +- sdks/php/docs/Model/AccountResponse.md | 22 +- sdks/php/docs/Model/AccountResponseQuotas.md | 12 +- sdks/php/docs/Model/AccountResponseUsage.md | 2 +- sdks/php/docs/Model/AccountUpdateRequest.md | 6 +- sdks/php/docs/Model/AccountVerifyRequest.md | 2 +- sdks/php/docs/Model/AccountVerifyResponse.md | 4 +- .../Model/AccountVerifyResponseAccount.md | 2 +- sdks/php/docs/Model/ApiAppCreateRequest.md | 14 +- sdks/php/docs/Model/ApiAppGetResponse.md | 4 +- sdks/php/docs/Model/ApiAppListResponse.md | 6 +- sdks/php/docs/Model/ApiAppResponse.md | 20 +- sdks/php/docs/Model/ApiAppResponseOAuth.md | 8 +- sdks/php/docs/Model/ApiAppResponseOptions.md | 2 +- .../docs/Model/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- sdks/php/docs/Model/ApiAppUpdateRequest.md | 14 +- sdks/php/docs/Model/BulkSendJobGetResponse.md | 8 +- ...BulkSendJobGetResponseSignatureRequests.md | 53 +- .../php/docs/Model/BulkSendJobListResponse.md | 6 +- sdks/php/docs/Model/BulkSendJobResponse.md | 8 +- .../php/docs/Model/BulkSendJobSendResponse.md | 4 +- sdks/php/docs/Model/EmbeddedEditUrlRequest.md | 24 +- .../php/docs/Model/EmbeddedEditUrlResponse.md | 4 +- .../Model/EmbeddedEditUrlResponseEmbedded.md | 4 +- .../php/docs/Model/EmbeddedSignUrlResponse.md | 4 +- .../Model/EmbeddedSignUrlResponseEmbedded.md | 4 +- sdks/php/docs/Model/ErrorResponse.md | 2 +- sdks/php/docs/Model/ErrorResponseError.md | 6 +- sdks/php/docs/Model/EventCallbackRequest.md | 8 +- .../docs/Model/EventCallbackRequestEvent.md | 8 +- .../EventCallbackRequestEventMetadata.md | 8 +- sdks/php/docs/Model/FaxGetResponse.md | 4 +- sdks/php/docs/Model/FaxLineAddUserRequest.md | 6 +- .../docs/Model/FaxLineAreaCodeGetResponse.md | 2 +- sdks/php/docs/Model/FaxLineCreateRequest.md | 8 +- sdks/php/docs/Model/FaxLineDeleteRequest.md | 2 +- sdks/php/docs/Model/FaxLineListResponse.md | 6 +- .../docs/Model/FaxLineRemoveUserRequest.md | 6 +- sdks/php/docs/Model/FaxLineResponse.md | 4 +- sdks/php/docs/Model/FaxLineResponseFaxLine.md | 8 +- sdks/php/docs/Model/FaxListResponse.md | 4 +- sdks/php/docs/Model/FaxResponse.md | 22 +- .../php/docs/Model/FaxResponseTransmission.md | 6 +- sdks/php/docs/Model/FaxSendRequest.md | 23 +- sdks/php/docs/Model/FileResponse.md | 4 +- sdks/php/docs/Model/FileResponseDataUri.md | 2 +- sdks/php/docs/Model/ListInfoResponse.md | 8 +- .../docs/Model/OAuthTokenGenerateRequest.md | 10 +- .../docs/Model/OAuthTokenRefreshRequest.md | 8 +- sdks/php/docs/Model/OAuthTokenResponse.md | 10 +- sdks/php/docs/Model/ReportCreateRequest.md | 6 +- sdks/php/docs/Model/ReportCreateResponse.md | 4 +- sdks/php/docs/Model/ReportResponse.md | 8 +- ...stBulkCreateEmbeddedWithTemplateRequest.md | 52 +- ...atureRequestBulkSendWithTemplateRequest.md | 52 +- .../SignatureRequestCreateEmbeddedRequest.md | 81 +- ...equestCreateEmbeddedWithTemplateRequest.md | 38 +- .../docs/Model/SignatureRequestGetResponse.md | 4 +- .../Model/SignatureRequestListResponse.md | 6 +- .../Model/SignatureRequestRemindRequest.md | 4 +- .../docs/Model/SignatureRequestResponse.md | 53 +- .../SignatureRequestResponseAttachment.md | 12 +- ...SignatureRequestResponseCustomFieldBase.md | 14 +- ...atureRequestResponseCustomFieldCheckbox.md | 6 +- ...SignatureRequestResponseCustomFieldText.md | 6 +- .../Model/SignatureRequestResponseDataBase.md | 10 +- ...gnatureRequestResponseDataValueCheckbox.md | 4 +- ...reRequestResponseDataValueCheckboxMerge.md | 4 +- ...atureRequestResponseDataValueDateSigned.md | 4 +- ...gnatureRequestResponseDataValueDropdown.md | 4 +- ...gnatureRequestResponseDataValueInitials.md | 6 +- .../SignatureRequestResponseDataValueRadio.md | 4 +- ...natureRequestResponseDataValueSignature.md | 6 +- .../SignatureRequestResponseDataValueText.md | 4 +- ...natureRequestResponseDataValueTextMerge.md | 4 +- .../SignatureRequestResponseSignatures.md | 38 +- .../docs/Model/SignatureRequestSendRequest.md | 90 +- ...SignatureRequestSendWithTemplateRequest.md | 47 +- .../Model/SignatureRequestUpdateRequest.md | 14 +- sdks/php/docs/Model/SubAttachment.md | 10 +- sdks/php/docs/Model/SubBulkSignerList.md | 6 +- .../Model/SubBulkSignerListCustomField.md | 4 +- sdks/php/docs/Model/SubCC.md | 4 +- sdks/php/docs/Model/SubCustomField.md | 16 +- sdks/php/docs/Model/SubEditorOptions.md | 4 +- sdks/php/docs/Model/SubFieldOptions.md | 4 +- sdks/php/docs/Model/SubFormFieldGroup.md | 10 +- sdks/php/docs/Model/SubFormFieldRule.md | 8 +- sdks/php/docs/Model/SubFormFieldRuleAction.md | 16 +- .../php/docs/Model/SubFormFieldRuleTrigger.md | 41 +- .../Model/SubFormFieldsPerDocumentBase.md | 49 +- .../Model/SubFormFieldsPerDocumentCheckbox.md | 8 +- .../SubFormFieldsPerDocumentCheckboxMerge.md | 4 +- .../SubFormFieldsPerDocumentDateSigned.md | 10 +- .../Model/SubFormFieldsPerDocumentDropdown.md | 14 +- .../SubFormFieldsPerDocumentHyperlink.md | 14 +- .../Model/SubFormFieldsPerDocumentInitials.md | 4 +- .../Model/SubFormFieldsPerDocumentRadio.md | 8 +- .../SubFormFieldsPerDocumentSignature.md | 4 +- .../Model/SubFormFieldsPerDocumentText.md | 28 +- .../SubFormFieldsPerDocumentTextMerge.md | 10 +- sdks/php/docs/Model/SubMergeField.md | 4 +- sdks/php/docs/Model/SubOAuth.md | 4 +- sdks/php/docs/Model/SubOptions.md | 2 +- .../SubSignatureRequestGroupedSigners.md | 8 +- .../docs/Model/SubSignatureRequestSigner.md | 20 +- .../SubSignatureRequestTemplateSigner.md | 20 +- sdks/php/docs/Model/SubSigningOptions.md | 12 +- sdks/php/docs/Model/SubTeamResponse.md | 4 +- sdks/php/docs/Model/SubTemplateRole.md | 4 +- .../php/docs/Model/SubUnclaimedDraftSigner.md | 6 +- .../Model/SubUnclaimedDraftTemplateSigner.md | 6 +- .../php/docs/Model/SubWhiteLabelingOptions.md | 30 +- sdks/php/docs/Model/TeamAddMemberRequest.md | 12 +- sdks/php/docs/Model/TeamCreateRequest.md | 2 +- sdks/php/docs/Model/TeamGetInfoResponse.md | 4 +- sdks/php/docs/Model/TeamGetResponse.md | 4 +- sdks/php/docs/Model/TeamInfoResponse.md | 10 +- sdks/php/docs/Model/TeamInviteResponse.md | 12 +- sdks/php/docs/Model/TeamInvitesResponse.md | 4 +- sdks/php/docs/Model/TeamMemberResponse.md | 6 +- sdks/php/docs/Model/TeamMembersResponse.md | 6 +- sdks/php/docs/Model/TeamParentResponse.md | 6 +- .../php/docs/Model/TeamRemoveMemberRequest.md | 18 +- sdks/php/docs/Model/TeamResponse.md | 8 +- sdks/php/docs/Model/TeamSubTeamsResponse.md | 6 +- sdks/php/docs/Model/TeamUpdateRequest.md | 2 +- sdks/php/docs/Model/TemplateAddUserRequest.md | 8 +- .../TemplateCreateEmbeddedDraftRequest.md | 75 +- .../TemplateCreateEmbeddedDraftResponse.md | 4 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 10 +- sdks/php/docs/Model/TemplateCreateRequest.md | 58 +- sdks/php/docs/Model/TemplateCreateResponse.md | 4 +- .../Model/TemplateCreateResponseTemplate.md | 4 +- sdks/php/docs/Model/TemplateEditResponse.md | 2 +- sdks/php/docs/Model/TemplateGetResponse.md | 4 +- sdks/php/docs/Model/TemplateListResponse.md | 6 +- .../docs/Model/TemplateRemoveUserRequest.md | 4 +- sdks/php/docs/Model/TemplateResponse.md | 34 +- .../php/docs/Model/TemplateResponseAccount.md | 12 +- .../Model/TemplateResponseAccountQuota.md | 8 +- sdks/php/docs/Model/TemplateResponseCCRole.md | 2 +- .../docs/Model/TemplateResponseDocument.md | 12 +- ...TemplateResponseDocumentCustomFieldBase.md | 20 +- ...lateResponseDocumentCustomFieldCheckbox.md | 7 +- ...TemplateResponseDocumentCustomFieldText.md | 15 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 8 +- .../TemplateResponseDocumentFormFieldBase.md | 18 +- ...mplateResponseDocumentFormFieldCheckbox.md | 15 +- ...lateResponseDocumentFormFieldDateSigned.md | 15 +- ...mplateResponseDocumentFormFieldDropdown.md | 15 +- ...plateResponseDocumentFormFieldHyperlink.md | 23 +- ...mplateResponseDocumentFormFieldInitials.md | 15 +- .../TemplateResponseDocumentFormFieldRadio.md | 15 +- ...plateResponseDocumentFormFieldSignature.md | 15 +- .../TemplateResponseDocumentFormFieldText.md | 25 +- ...TemplateResponseDocumentStaticFieldBase.md | 20 +- ...lateResponseDocumentStaticFieldCheckbox.md | 13 +- ...teResponseDocumentStaticFieldDateSigned.md | 13 +- ...lateResponseDocumentStaticFieldDropdown.md | 13 +- ...ateResponseDocumentStaticFieldHyperlink.md | 13 +- ...lateResponseDocumentStaticFieldInitials.md | 13 +- ...emplateResponseDocumentStaticFieldRadio.md | 13 +- ...ateResponseDocumentStaticFieldSignature.md | 13 +- ...TemplateResponseDocumentStaticFieldText.md | 13 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/Model/TemplateResponseSignerRole.md | 4 +- .../docs/Model/TemplateUpdateFilesRequest.md | 16 +- .../docs/Model/TemplateUpdateFilesResponse.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 4 +- .../UnclaimedDraftCreateEmbeddedRequest.md | 104 +- ...dDraftCreateEmbeddedWithTemplateRequest.md | 78 +- .../docs/Model/UnclaimedDraftCreateRequest.md | 73 +- .../Model/UnclaimedDraftCreateResponse.md | 4 +- .../UnclaimedDraftEditAndResendRequest.md | 16 +- sdks/php/docs/Model/UnclaimedDraftResponse.md | 12 +- sdks/php/docs/Model/WarningResponse.md | 4 +- sdks/php/src/Api/AccountApi.php | 502 ++--- sdks/php/src/Api/ApiAppApi.php | 593 +++--- sdks/php/src/Api/BulkSendJobApi.php | 309 ++- sdks/php/src/Api/EmbeddedApi.php | 293 ++- sdks/php/src/Api/FaxApi.php | 585 +++--- sdks/php/src/Api/FaxLineApi.php | 845 ++++---- sdks/php/src/Api/OAuthApi.php | 342 ++-- sdks/php/src/Api/ReportApi.php | 173 +- sdks/php/src/Api/SignatureRequestApi.php | 1795 ++++++++--------- sdks/php/src/Api/TeamApi.php | 1116 +++++----- sdks/php/src/Api/TemplateApi.php | 1305 ++++++------ sdks/php/src/Api/UnclaimedDraftApi.php | 507 +++-- sdks/php/src/ApiException.php | 27 +- sdks/php/src/Configuration.php | 104 +- sdks/php/src/EventCallbackHelper.php | 8 +- sdks/php/src/HeaderSelector.php | 65 +- sdks/php/src/Model/AccountCreateRequest.php | 165 +- sdks/php/src/Model/AccountCreateResponse.php | 171 +- sdks/php/src/Model/AccountGetResponse.php | 163 +- sdks/php/src/Model/AccountResponse.php | 217 +- sdks/php/src/Model/AccountResponseQuotas.php | 184 +- sdks/php/src/Model/AccountResponseUsage.php | 154 +- sdks/php/src/Model/AccountUpdateRequest.php | 165 +- sdks/php/src/Model/AccountVerifyRequest.php | 153 +- sdks/php/src/Model/AccountVerifyResponse.php | 167 +- .../Model/AccountVerifyResponseAccount.php | 157 +- sdks/php/src/Model/ApiAppCreateRequest.php | 210 +- sdks/php/src/Model/ApiAppGetResponse.php | 163 +- sdks/php/src/Model/ApiAppListResponse.php | 171 +- sdks/php/src/Model/ApiAppResponse.php | 207 +- sdks/php/src/Model/ApiAppResponseOAuth.php | 175 +- sdks/php/src/Model/ApiAppResponseOptions.php | 155 +- .../src/Model/ApiAppResponseOwnerAccount.php | 159 +- .../ApiAppResponseWhiteLabelingOptions.php | 207 +- sdks/php/src/Model/ApiAppUpdateRequest.php | 202 +- sdks/php/src/Model/BulkSendJobGetResponse.php | 179 +- ...ulkSendJobGetResponseSignatureRequests.php | 299 ++- .../php/src/Model/BulkSendJobListResponse.php | 171 +- sdks/php/src/Model/BulkSendJobResponse.php | 175 +- .../php/src/Model/BulkSendJobSendResponse.php | 163 +- sdks/php/src/Model/EmbeddedEditUrlRequest.php | 209 +- .../php/src/Model/EmbeddedEditUrlResponse.php | 163 +- .../Model/EmbeddedEditUrlResponseEmbedded.php | 163 +- .../php/src/Model/EmbeddedSignUrlResponse.php | 163 +- .../Model/EmbeddedSignUrlResponseEmbedded.php | 163 +- sdks/php/src/Model/ErrorResponse.php | 155 +- sdks/php/src/Model/ErrorResponseError.php | 165 +- sdks/php/src/Model/EventCallbackRequest.php | 179 +- .../src/Model/EventCallbackRequestEvent.php | 174 +- .../EventCallbackRequestEventMetadata.php | 172 +- sdks/php/src/Model/FaxGetResponse.php | 163 +- sdks/php/src/Model/FaxLineAddUserRequest.php | 159 +- .../Model/FaxLineAreaCodeGetCountryEnum.php | 13 +- .../Model/FaxLineAreaCodeGetProvinceEnum.php | 13 +- .../src/Model/FaxLineAreaCodeGetResponse.php | 151 +- .../src/Model/FaxLineAreaCodeGetStateEnum.php | 13 +- sdks/php/src/Model/FaxLineCreateRequest.php | 164 +- sdks/php/src/Model/FaxLineDeleteRequest.php | 151 +- sdks/php/src/Model/FaxLineListResponse.php | 171 +- .../src/Model/FaxLineRemoveUserRequest.php | 159 +- sdks/php/src/Model/FaxLineResponse.php | 163 +- sdks/php/src/Model/FaxLineResponseFaxLine.php | 171 +- sdks/php/src/Model/FaxListResponse.php | 163 +- sdks/php/src/Model/FaxResponse.php | 195 +- .../php/src/Model/FaxResponseTransmission.php | 160 +- sdks/php/src/Model/FaxSendRequest.php | 190 +- sdks/php/src/Model/FileResponse.php | 159 +- sdks/php/src/Model/FileResponseDataUri.php | 153 +- sdks/php/src/Model/ListInfoResponse.php | 175 +- sdks/php/src/Model/ModelInterface.php | 13 +- .../src/Model/OAuthTokenGenerateRequest.php | 177 +- .../src/Model/OAuthTokenRefreshRequest.php | 167 +- sdks/php/src/Model/OAuthTokenResponse.php | 171 +- sdks/php/src/Model/ReportCreateRequest.php | 176 +- sdks/php/src/Model/ReportCreateResponse.php | 163 +- sdks/php/src/Model/ReportResponse.php | 172 +- ...tBulkCreateEmbeddedWithTemplateRequest.php | 239 +-- ...tureRequestBulkSendWithTemplateRequest.php | 239 +-- .../SignatureRequestCreateEmbeddedRequest.php | 305 ++- ...questCreateEmbeddedWithTemplateRequest.php | 249 ++- .../src/Model/SignatureRequestGetResponse.php | 163 +- .../Model/SignatureRequestListResponse.php | 171 +- .../Model/SignatureRequestRemindRequest.php | 157 +- .../src/Model/SignatureRequestResponse.php | 299 ++- .../SignatureRequestResponseAttachment.php | 183 +- ...ignatureRequestResponseCustomFieldBase.php | 163 +- ...tureRequestResponseCustomFieldCheckbox.php | 152 +- ...ignatureRequestResponseCustomFieldText.php | 152 +- ...tureRequestResponseCustomFieldTypeEnum.php | 13 +- .../SignatureRequestResponseDataBase.php | 167 +- .../SignatureRequestResponseDataTypeEnum.php | 13 +- ...natureRequestResponseDataValueCheckbox.php | 158 +- ...eRequestResponseDataValueCheckboxMerge.php | 158 +- ...tureRequestResponseDataValueDateSigned.php | 158 +- ...natureRequestResponseDataValueDropdown.php | 158 +- ...natureRequestResponseDataValueInitials.php | 164 +- ...SignatureRequestResponseDataValueRadio.php | 158 +- ...atureRequestResponseDataValueSignature.php | 164 +- .../SignatureRequestResponseDataValueText.php | 158 +- ...atureRequestResponseDataValueTextMerge.php | 158 +- .../SignatureRequestResponseSignatures.php | 261 ++- .../src/Model/SignatureRequestSendRequest.php | 315 ++- ...ignatureRequestSendWithTemplateRequest.php | 261 ++- .../Model/SignatureRequestUpdateRequest.php | 165 +- sdks/php/src/Model/SubAttachment.php | 169 +- sdks/php/src/Model/SubBulkSignerList.php | 167 +- .../Model/SubBulkSignerListCustomField.php | 157 +- sdks/php/src/Model/SubCC.php | 157 +- sdks/php/src/Model/SubCustomField.php | 165 +- sdks/php/src/Model/SubEditorOptions.php | 159 +- sdks/php/src/Model/SubFieldOptions.php | 154 +- sdks/php/src/Model/SubFormFieldGroup.php | 159 +- sdks/php/src/Model/SubFormFieldRule.php | 192 +- sdks/php/src/Model/SubFormFieldRuleAction.php | 166 +- .../php/src/Model/SubFormFieldRuleTrigger.php | 164 +- .../Model/SubFormFieldsPerDocumentBase.php | 195 +- .../SubFormFieldsPerDocumentCheckbox.php | 160 +- .../SubFormFieldsPerDocumentCheckboxMerge.php | 148 +- .../SubFormFieldsPerDocumentDateSigned.php | 159 +- .../SubFormFieldsPerDocumentDropdown.php | 176 +- .../SubFormFieldsPerDocumentFontEnum.php | 13 +- .../SubFormFieldsPerDocumentHyperlink.php | 171 +- .../SubFormFieldsPerDocumentInitials.php | 148 +- .../Model/SubFormFieldsPerDocumentRadio.php | 158 +- .../SubFormFieldsPerDocumentSignature.php | 148 +- .../Model/SubFormFieldsPerDocumentText.php | 195 +- .../SubFormFieldsPerDocumentTextMerge.php | 159 +- .../SubFormFieldsPerDocumentTypeEnum.php | 13 +- sdks/php/src/Model/SubMergeField.php | 158 +- sdks/php/src/Model/SubOAuth.php | 160 +- sdks/php/src/Model/SubOptions.php | 157 +- .../SubSignatureRequestGroupedSigners.php | 165 +- .../src/Model/SubSignatureRequestSigner.php | 188 +- .../SubSignatureRequestTemplateSigner.php | 186 +- sdks/php/src/Model/SubSigningOptions.php | 168 +- sdks/php/src/Model/SubTeamResponse.php | 159 +- sdks/php/src/Model/SubTemplateRole.php | 163 +- .../php/src/Model/SubUnclaimedDraftSigner.php | 165 +- .../Model/SubUnclaimedDraftTemplateSigner.php | 165 +- .../php/src/Model/SubWhiteLabelingOptions.php | 208 +- sdks/php/src/Model/TeamAddMemberRequest.php | 160 +- sdks/php/src/Model/TeamCreateRequest.php | 157 +- sdks/php/src/Model/TeamGetInfoResponse.php | 163 +- sdks/php/src/Model/TeamGetResponse.php | 163 +- sdks/php/src/Model/TeamInfoResponse.php | 175 +- sdks/php/src/Model/TeamInviteResponse.php | 187 +- sdks/php/src/Model/TeamInvitesResponse.php | 163 +- sdks/php/src/Model/TeamMemberResponse.php | 169 +- sdks/php/src/Model/TeamMembersResponse.php | 171 +- sdks/php/src/Model/TeamParentResponse.php | 159 +- .../php/src/Model/TeamRemoveMemberRequest.php | 170 +- sdks/php/src/Model/TeamResponse.php | 177 +- sdks/php/src/Model/TeamSubTeamsResponse.php | 171 +- sdks/php/src/Model/TeamUpdateRequest.php | 157 +- sdks/php/src/Model/TemplateAddUserRequest.php | 163 +- .../TemplateCreateEmbeddedDraftRequest.php | 309 ++- .../TemplateCreateEmbeddedDraftResponse.php | 163 +- ...ateCreateEmbeddedDraftResponseTemplate.php | 177 +- sdks/php/src/Model/TemplateCreateRequest.php | 269 ++- sdks/php/src/Model/TemplateCreateResponse.php | 163 +- .../Model/TemplateCreateResponseTemplate.php | 157 +- sdks/php/src/Model/TemplateEditResponse.php | 153 +- sdks/php/src/Model/TemplateGetResponse.php | 163 +- sdks/php/src/Model/TemplateListResponse.php | 171 +- .../src/Model/TemplateRemoveUserRequest.php | 159 +- sdks/php/src/Model/TemplateResponse.php | 253 ++- .../php/src/Model/TemplateResponseAccount.php | 189 +- .../Model/TemplateResponseAccountQuota.php | 175 +- sdks/php/src/Model/TemplateResponseCCRole.php | 157 +- .../src/Model/TemplateResponseDocument.php | 195 +- ...emplateResponseDocumentCustomFieldBase.php | 189 +- ...ateResponseDocumentCustomFieldCheckbox.php | 148 +- ...emplateResponseDocumentCustomFieldText.php | 174 +- .../TemplateResponseDocumentFieldGroup.php | 165 +- ...TemplateResponseDocumentFieldGroupRule.php | 159 +- .../TemplateResponseDocumentFormFieldBase.php | 187 +- ...plateResponseDocumentFormFieldCheckbox.php | 152 +- ...ateResponseDocumentFormFieldDateSigned.php | 152 +- ...plateResponseDocumentFormFieldDropdown.php | 152 +- ...lateResponseDocumentFormFieldHyperlink.php | 178 +- ...plateResponseDocumentFormFieldInitials.php | 152 +- ...TemplateResponseDocumentFormFieldRadio.php | 152 +- ...lateResponseDocumentFormFieldSignature.php | 152 +- .../TemplateResponseDocumentFormFieldText.php | 183 +- ...emplateResponseDocumentStaticFieldBase.php | 191 +- ...ateResponseDocumentStaticFieldCheckbox.php | 148 +- ...eResponseDocumentStaticFieldDateSigned.php | 148 +- ...ateResponseDocumentStaticFieldDropdown.php | 148 +- ...teResponseDocumentStaticFieldHyperlink.php | 148 +- ...ateResponseDocumentStaticFieldInitials.php | 148 +- ...mplateResponseDocumentStaticFieldRadio.php | 148 +- ...teResponseDocumentStaticFieldSignature.php | 148 +- ...emplateResponseDocumentStaticFieldText.php | 148 +- .../TemplateResponseFieldAvgTextLength.php | 163 +- .../src/Model/TemplateResponseSignerRole.php | 163 +- .../src/Model/TemplateUpdateFilesRequest.php | 190 +- .../src/Model/TemplateUpdateFilesResponse.php | 155 +- .../TemplateUpdateFilesResponseTemplate.php | 165 +- .../UnclaimedDraftCreateEmbeddedRequest.php | 364 ++-- ...DraftCreateEmbeddedWithTemplateRequest.php | 331 ++- .../src/Model/UnclaimedDraftCreateRequest.php | 302 ++- .../Model/UnclaimedDraftCreateResponse.php | 163 +- .../UnclaimedDraftEditAndResendRequest.php | 191 +- sdks/php/src/Model/UnclaimedDraftResponse.php | 183 +- sdks/php/src/Model/WarningResponse.php | 155 +- sdks/php/src/ObjectSerializer.php | 305 ++- sdks/python/docs/FaxApi.md | 14 +- sdks/python/docs/FaxLineAddUserRequest.md | 2 +- sdks/python/docs/FaxLineApi.md | 22 +- sdks/python/docs/FaxLineCreateRequest.md | 8 +- sdks/python/docs/FaxLineDeleteRequest.md | 2 +- sdks/python/docs/FaxLineRemoveUserRequest.md | 6 +- sdks/python/docs/FaxSendRequest.md | 10 +- sdks/python/dropbox_sign/__init__.py | 12 +- sdks/python/dropbox_sign/api/account_api.py | 12 +- sdks/python/dropbox_sign/api/api_app_api.py | 12 +- .../dropbox_sign/api/bulk_send_job_api.py | 12 +- sdks/python/dropbox_sign/api/embedded_api.py | 12 +- sdks/python/dropbox_sign/api/fax_api.py | 78 +- sdks/python/dropbox_sign/api/fax_line_api.py | 159 +- sdks/python/dropbox_sign/api/o_auth_api.py | 12 +- sdks/python/dropbox_sign/api/report_api.py | 12 +- .../dropbox_sign/api/signature_request_api.py | 12 +- sdks/python/dropbox_sign/api/team_api.py | 12 +- sdks/python/dropbox_sign/api/template_api.py | 12 +- .../dropbox_sign/api/unclaimed_draft_api.py | 12 +- sdks/python/dropbox_sign/api_client.py | 12 +- sdks/python/dropbox_sign/configuration.py | 12 +- sdks/python/dropbox_sign/exceptions.py | 12 +- sdks/python/dropbox_sign/models/__init__.py | 12 +- .../models/account_create_request.py | 12 +- .../models/account_create_response.py | 12 +- .../models/account_get_response.py | 12 +- .../dropbox_sign/models/account_response.py | 12 +- .../models/account_response_quotas.py | 12 +- .../models/account_response_usage.py | 12 +- .../models/account_update_request.py | 12 +- .../models/account_verify_request.py | 12 +- .../models/account_verify_response.py | 12 +- .../models/account_verify_response_account.py | 12 +- .../models/api_app_create_request.py | 12 +- .../models/api_app_get_response.py | 12 +- .../models/api_app_list_response.py | 12 +- .../dropbox_sign/models/api_app_response.py | 12 +- .../models/api_app_response_o_auth.py | 12 +- .../models/api_app_response_options.py | 12 +- .../models/api_app_response_owner_account.py | 12 +- ...api_app_response_white_labeling_options.py | 12 +- .../models/api_app_update_request.py | 12 +- .../models/bulk_send_job_get_response.py | 12 +- ...end_job_get_response_signature_requests.py | 12 +- .../models/bulk_send_job_list_response.py | 12 +- .../models/bulk_send_job_response.py | 12 +- .../models/bulk_send_job_send_response.py | 12 +- .../models/embedded_edit_url_request.py | 12 +- .../models/embedded_edit_url_response.py | 12 +- .../embedded_edit_url_response_embedded.py | 12 +- .../models/embedded_sign_url_response.py | 12 +- .../embedded_sign_url_response_embedded.py | 12 +- .../dropbox_sign/models/error_response.py | 12 +- .../models/error_response_error.py | 12 +- .../models/event_callback_request.py | 12 +- .../models/event_callback_request_event.py | 12 +- .../event_callback_request_event_metadata.py | 12 +- .../dropbox_sign/models/fax_get_response.py | 12 +- .../models/fax_line_add_user_request.py | 14 +- .../fax_line_area_code_get_country_enum.py | 12 +- .../fax_line_area_code_get_province_enum.py | 12 +- .../models/fax_line_area_code_get_response.py | 12 +- .../fax_line_area_code_get_state_enum.py | 12 +- .../models/fax_line_create_request.py | 23 +- .../models/fax_line_delete_request.py | 14 +- .../models/fax_line_list_response.py | 12 +- .../models/fax_line_remove_user_request.py | 20 +- .../dropbox_sign/models/fax_line_response.py | 12 +- .../models/fax_line_response_fax_line.py | 12 +- .../dropbox_sign/models/fax_list_response.py | 12 +- .../dropbox_sign/models/fax_response.py | 12 +- .../models/fax_response_transmission.py | 12 +- .../dropbox_sign/models/fax_send_request.py | 26 +- .../dropbox_sign/models/file_response.py | 12 +- .../models/file_response_data_uri.py | 12 +- .../dropbox_sign/models/list_info_response.py | 12 +- .../models/o_auth_token_generate_request.py | 12 +- .../models/o_auth_token_refresh_request.py | 12 +- .../models/o_auth_token_response.py | 12 +- .../models/report_create_request.py | 12 +- .../models/report_create_response.py | 12 +- .../dropbox_sign/models/report_response.py | 12 +- ...k_create_embedded_with_template_request.py | 12 +- ...request_bulk_send_with_template_request.py | 12 +- ...gnature_request_create_embedded_request.py | 12 +- ...t_create_embedded_with_template_request.py | 12 +- .../models/signature_request_get_response.py | 12 +- .../models/signature_request_list_response.py | 12 +- .../signature_request_remind_request.py | 12 +- .../models/signature_request_response.py | 12 +- .../signature_request_response_attachment.py | 12 +- ...ture_request_response_custom_field_base.py | 12 +- ..._request_response_custom_field_checkbox.py | 12 +- ...ture_request_response_custom_field_text.py | 12 +- ...request_response_custom_field_type_enum.py | 12 +- .../signature_request_response_data_base.py | 12 +- ...gnature_request_response_data_type_enum.py | 12 +- ...re_request_response_data_value_checkbox.py | 12 +- ...uest_response_data_value_checkbox_merge.py | 12 +- ...request_response_data_value_date_signed.py | 12 +- ...re_request_response_data_value_dropdown.py | 12 +- ...re_request_response_data_value_initials.py | 12 +- ...ature_request_response_data_value_radio.py | 12 +- ...e_request_response_data_value_signature.py | 12 +- ...nature_request_response_data_value_text.py | 12 +- ..._request_response_data_value_text_merge.py | 12 +- .../signature_request_response_signatures.py | 12 +- .../models/signature_request_send_request.py | 12 +- ...ture_request_send_with_template_request.py | 12 +- .../signature_request_update_request.py | 12 +- .../dropbox_sign/models/sub_attachment.py | 12 +- .../models/sub_bulk_signer_list.py | 12 +- .../sub_bulk_signer_list_custom_field.py | 12 +- sdks/python/dropbox_sign/models/sub_cc.py | 12 +- .../dropbox_sign/models/sub_custom_field.py | 12 +- .../dropbox_sign/models/sub_editor_options.py | 12 +- .../dropbox_sign/models/sub_field_options.py | 12 +- .../models/sub_form_field_group.py | 12 +- .../models/sub_form_field_rule.py | 12 +- .../models/sub_form_field_rule_action.py | 12 +- .../models/sub_form_field_rule_trigger.py | 12 +- .../sub_form_fields_per_document_base.py | 12 +- .../sub_form_fields_per_document_checkbox.py | 12 +- ...form_fields_per_document_checkbox_merge.py | 12 +- ...ub_form_fields_per_document_date_signed.py | 12 +- .../sub_form_fields_per_document_dropdown.py | 12 +- .../sub_form_fields_per_document_font_enum.py | 12 +- .../sub_form_fields_per_document_hyperlink.py | 12 +- .../sub_form_fields_per_document_initials.py | 12 +- .../sub_form_fields_per_document_radio.py | 12 +- .../sub_form_fields_per_document_signature.py | 12 +- .../sub_form_fields_per_document_text.py | 12 +- ...sub_form_fields_per_document_text_merge.py | 12 +- .../sub_form_fields_per_document_type_enum.py | 12 +- .../dropbox_sign/models/sub_merge_field.py | 12 +- sdks/python/dropbox_sign/models/sub_o_auth.py | 12 +- .../python/dropbox_sign/models/sub_options.py | 12 +- .../sub_signature_request_grouped_signers.py | 12 +- .../models/sub_signature_request_signer.py | 12 +- .../sub_signature_request_template_signer.py | 12 +- .../models/sub_signing_options.py | 12 +- .../dropbox_sign/models/sub_team_response.py | 12 +- .../dropbox_sign/models/sub_template_role.py | 12 +- .../models/sub_unclaimed_draft_signer.py | 12 +- .../sub_unclaimed_draft_template_signer.py | 12 +- .../models/sub_white_labeling_options.py | 12 +- .../models/team_add_member_request.py | 12 +- .../models/team_create_request.py | 12 +- .../models/team_get_info_response.py | 12 +- .../dropbox_sign/models/team_get_response.py | 12 +- .../dropbox_sign/models/team_info_response.py | 12 +- .../models/team_invite_response.py | 12 +- .../models/team_invites_response.py | 12 +- .../models/team_member_response.py | 12 +- .../models/team_members_response.py | 12 +- .../models/team_parent_response.py | 12 +- .../models/team_remove_member_request.py | 12 +- .../dropbox_sign/models/team_response.py | 12 +- .../models/team_sub_teams_response.py | 12 +- .../models/team_update_request.py | 12 +- .../models/template_add_user_request.py | 12 +- .../template_create_embedded_draft_request.py | 12 +- ...template_create_embedded_draft_response.py | 12 +- ...create_embedded_draft_response_template.py | 12 +- .../models/template_create_request.py | 12 +- .../models/template_create_response.py | 12 +- .../template_create_response_template.py | 12 +- .../models/template_edit_response.py | 12 +- .../models/template_get_response.py | 12 +- .../models/template_list_response.py | 12 +- .../models/template_remove_user_request.py | 12 +- .../dropbox_sign/models/template_response.py | 12 +- .../models/template_response_account.py | 12 +- .../models/template_response_account_quota.py | 12 +- .../models/template_response_cc_role.py | 12 +- .../models/template_response_document.py | 12 +- ...ate_response_document_custom_field_base.py | 12 +- ...response_document_custom_field_checkbox.py | 12 +- ...ate_response_document_custom_field_text.py | 12 +- .../template_response_document_field_group.py | 12 +- ...late_response_document_field_group_rule.py | 12 +- ...plate_response_document_form_field_base.py | 12 +- ...e_response_document_form_field_checkbox.py | 12 +- ...esponse_document_form_field_date_signed.py | 12 +- ...e_response_document_form_field_dropdown.py | 12 +- ..._response_document_form_field_hyperlink.py | 12 +- ...e_response_document_form_field_initials.py | 12 +- ...late_response_document_form_field_radio.py | 12 +- ..._response_document_form_field_signature.py | 12 +- ...plate_response_document_form_field_text.py | 12 +- ...ate_response_document_static_field_base.py | 12 +- ...response_document_static_field_checkbox.py | 12 +- ...ponse_document_static_field_date_signed.py | 12 +- ...response_document_static_field_dropdown.py | 12 +- ...esponse_document_static_field_hyperlink.py | 12 +- ...response_document_static_field_initials.py | 12 +- ...te_response_document_static_field_radio.py | 12 +- ...esponse_document_static_field_signature.py | 12 +- ...ate_response_document_static_field_text.py | 12 +- ...template_response_field_avg_text_length.py | 12 +- .../models/template_response_signer_role.py | 12 +- .../models/template_update_files_request.py | 12 +- .../models/template_update_files_response.py | 12 +- ...template_update_files_response_template.py | 12 +- ...unclaimed_draft_create_embedded_request.py | 12 +- ...t_create_embedded_with_template_request.py | 12 +- .../models/unclaimed_draft_create_request.py | 12 +- .../models/unclaimed_draft_create_response.py | 12 +- ...unclaimed_draft_edit_and_resend_request.py | 12 +- .../models/unclaimed_draft_response.py | 12 +- .../dropbox_sign/models/warning_response.py | 12 +- sdks/python/dropbox_sign/rest.py | 12 +- sdks/ruby/docs/FaxApi.md | 14 +- sdks/ruby/docs/FaxLineAddUserRequest.md | 2 +- sdks/ruby/docs/FaxLineApi.md | 22 +- sdks/ruby/docs/FaxLineCreateRequest.md | 8 +- sdks/ruby/docs/FaxLineDeleteRequest.md | 2 +- sdks/ruby/docs/FaxLineRemoveUserRequest.md | 6 +- sdks/ruby/docs/FaxSendRequest.md | 10 +- sdks/ruby/lib/dropbox-sign/api/fax_api.rb | 28 +- .../ruby/lib/dropbox-sign/api/fax_line_api.rb | 44 +- .../models/fax_line_add_user_request.rb | 2 +- .../models/fax_line_create_request.rb | 8 +- .../models/fax_line_delete_request.rb | 2 +- .../models/fax_line_remove_user_request.rb | 6 +- .../dropbox-sign/models/fax_send_request.rb | 10 +- 627 files changed, 22746 insertions(+), 25829 deletions(-) diff --git a/sdks/php/README.md b/sdks/php/README.md index d433ddf5c..946c74e1f 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -73,7 +73,32 @@ Please follow the [installation procedure](#installation--usage) and then run th ```php -REPLACE_ME_WITH_EXAMPLE_FOR__accountCreate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$accountApi = new Dropbox\Sign\Api\AccountApi($config); + +$data = new Dropbox\Sign\Model\AccountCreateRequest(); +$data->setEmailAddress("newuser@dropboxsign.com"); + +try { + $result = $accountApi->accountCreate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` You may also instantiate objects by calling the class' `::init()` method: diff --git a/sdks/php/docs/Api/AccountApi.md b/sdks/php/docs/Api/AccountApi.md index c5c923f53..9c8e8c9f0 100644 --- a/sdks/php/docs/Api/AccountApi.md +++ b/sdks/php/docs/Api/AccountApi.md @@ -22,7 +22,32 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__accountCreate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$accountApi = new Dropbox\Sign\Api\AccountApi($config); + +$data = new Dropbox\Sign\Model\AccountCreateRequest(); +$data->setEmailAddress("newuser@dropboxsign.com"); + +try { + $result = $accountApi->accountCreate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -60,15 +85,37 @@ Returns the properties and settings of your Account. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__accountGet_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$accountApi = new Dropbox\Sign\Api\AccountApi($config); + +try { + $result = $accountApi->accountGet(null, 'jack@example.com'); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **account_id** | **string**| `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. | [optional] | -| **email_address** | **string**| `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. | [optional] | +| **account_id** | **string**| `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. | [optional] | +| **email_address** | **string**| `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. | [optional] | ### Return type @@ -99,7 +146,32 @@ Updates the properties and settings of your Account. Currently only allows for u ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__accountUpdate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$accountApi = new Dropbox\Sign\Api\AccountApi($config); + +$data = new Dropbox\Sign\Model\AccountUpdateRequest(); +$data->setCallbackUrl("https://www.example.com/callback"); + +try { + $result = $accountApi->accountUpdate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -137,7 +209,32 @@ Verifies whether an Dropbox Sign Account exists for the given email address. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__accountVerify_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$accountApi = new Dropbox\Sign\Api\AccountApi($config); + +$data = new Dropbox\Sign\Model\AccountVerifyRequest(); +$data->setEmailAddress("some_user@dropboxsign.com"); + +try { + $result = $accountApi->accountVerify($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Api/ApiAppApi.md b/sdks/php/docs/Api/ApiAppApi.md index 9b9e8978b..45604a821 100644 --- a/sdks/php/docs/Api/ApiAppApi.md +++ b/sdks/php/docs/Api/ApiAppApi.md @@ -23,7 +23,49 @@ Creates a new API App. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__apiAppCreate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); + +$oauth = new Dropbox\Sign\Model\SubOAuth(); +$oauth->setCallbackUrl("https://example.com/oauth") + ->setScopes([ + Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, + Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, + ]); + +$whiteLabelingOptions = new Dropbox\Sign\Model\SubWhiteLabelingOptions(); +$whiteLabelingOptions->setPrimaryButtonColor("#00b3e6") + ->setPrimaryButtonTextColor("#ffffff"); + +$customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); + +$data = new Dropbox\Sign\Model\ApiAppCreateRequest(); +$data->setName("My Production App") + ->setDomains(["example.com"]) + ->setOauth($oauth) + ->setWhiteLabelingOptions($whiteLabelingOptions) + ->setCustomLogoFile($customLogoFile); + +try { + $result = $apiAppApi->apiAppCreate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -61,7 +103,30 @@ Deletes an API App. Can only be invoked for apps you own. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__apiAppDelete_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); + +$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; + +try { + $apiAppApi->apiAppDelete($clientId); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -99,7 +164,31 @@ Returns an object with information about an API App. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__apiAppGet_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); + +$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; + +try { + $result = $apiAppApi->apiAppGet($clientId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -137,15 +226,40 @@ Returns a list of API Apps that are accessible by you. If you are on a team with ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__apiAppList_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); + +$page = 1; +$pageSize = 2; + +try { + $result = $apiAppApi->apiAppList($page, $pageSize); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **int**| Which page number of the API App List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **page** | **int**| Which page number of the API App List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -176,7 +290,43 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__apiAppUpdate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); + +$whiteLabelingOptions = new Dropbox\Sign\Model\SubWhiteLabelingOptions(); +$whiteLabelingOptions->setPrimaryButtonColor("#00b3e6") + ->setPrimaryButtonTextColor("#ffffff"); + +$customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); + +$data = new Dropbox\Sign\Model\ApiAppUpdateRequest(); +$data->setName("New Name") + ->setCallbackUrl("https://example.com/dropboxsign") + ->setWhiteLabelingOptions($whiteLabelingOptions) + ->setCustomLogoFile($customLogoFile); + +$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; + +try { + $result = $apiAppApi->apiAppUpdate($clientId, $data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Api/BulkSendJobApi.md b/sdks/php/docs/Api/BulkSendJobApi.md index 2fa0513a7..ede4f3415 100644 --- a/sdks/php/docs/Api/BulkSendJobApi.md +++ b/sdks/php/docs/Api/BulkSendJobApi.md @@ -20,7 +20,31 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__bulkSendJobGet_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config); + +$bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; + +try { + $result = $bulkSendJobApi->bulkSendJobGet($bulkSendJobId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -28,8 +52,8 @@ REPLACE_ME_WITH_EXAMPLE_FOR__bulkSendJobGet_PHP_CODE |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **bulk_send_job_id** | **string**| The id of the BulkSendJob to retrieve. | | -| **page** | **int**| Which page number of the BulkSendJob list to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional] [default to 20] | +| **page** | **int**| Which page number of the BulkSendJob list to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional] [default to 20] | ### Return type @@ -60,15 +84,40 @@ Returns a list of BulkSendJob that you can access. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__bulkSendJobList_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config); + +$page = 1; +$pageSize = 20; + +try { + $result = $bulkSendJobApi->bulkSendJobList($page, $pageSize); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **int**| Which page number of the BulkSendJob List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional] [default to 20] | +| **page** | **int**| Which page number of the BulkSendJob List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional] [default to 20] | ### Return type diff --git a/sdks/php/docs/Api/EmbeddedApi.md b/sdks/php/docs/Api/EmbeddedApi.md index 768017fd0..8b1acfbc4 100644 --- a/sdks/php/docs/Api/EmbeddedApi.md +++ b/sdks/php/docs/Api/EmbeddedApi.md @@ -20,7 +20,35 @@ Retrieves an embedded object containing a template url that can be opened in an ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__embeddedEditUrl_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$embeddedApi = new Dropbox\Sign\Api\EmbeddedApi($config); + +$data = new Dropbox\Sign\Model\EmbeddedEditUrlRequest(); +$data->setCcRoles([""]) + ->setMergeFields([]); + +$templateId = "5de8179668f2033afac48da1868d0093bf133266"; + +try { + $result = $embeddedApi->embeddedEditUrl($templateId, $data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -59,7 +87,31 @@ Retrieves an embedded object containing a signature url that can be opened in an ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__embeddedSignUrl_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$embeddedApi = new Dropbox\Sign\Api\EmbeddedApi($config); + +$signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; + +try { + $result = $embeddedApi->embeddedSignUrl($signatureId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Api/FaxApi.md b/sdks/php/docs/Api/FaxApi.md index 06a4b0d44..85450d672 100644 --- a/sdks/php/docs/Api/FaxApi.md +++ b/sdks/php/docs/Api/FaxApi.md @@ -23,7 +23,25 @@ Deletes the specified Fax from the system ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxDelete_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +try { + $faxApi->faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -61,7 +79,28 @@ Downloads files associated with a Fax ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxFiles_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +try { + $result = $faxApi->faxFiles($faxId); + copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -99,7 +138,28 @@ Returns information about a Fax ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxGet_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +try { + $result = $faxApi->faxGet($faxId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -137,15 +197,37 @@ Returns properties of multiple Faxes ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxList_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$page = 1; +$pageSize = 2; + +try { + $result = $faxApi->faxList($page, $pageSize); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **int**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **page** | **int**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -176,7 +258,36 @@ Creates and sends a new Fax with the submitted file(s) ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxSend_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$data = new Dropbox\Sign\Model\FaxSendRequest(); +$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) + ->setTestMode(true) + ->setRecipient("16690000001") + ->setSender("16690000000") + ->setCoverPageTo("Jill Fax") + ->setCoverPageMessage("I'm sending you a fax!") + ->setCoverPageFrom("Faxer Faxerson") + ->setTitle("This is what the fax is about!"); + +try { + $result = $faxApi->faxSend($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Api/FaxLineApi.md b/sdks/php/docs/Api/FaxLineApi.md index 82f1494ec..eb8df874f 100644 --- a/sdks/php/docs/Api/FaxLineApi.md +++ b/sdks/php/docs/Api/FaxLineApi.md @@ -25,7 +25,30 @@ Grants a user access to the specified Fax Line. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxLineAddUser_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); + +$data = new Dropbox\Sign\Model\FaxLineAddUserRequest(); +$data->setNumber("[FAX_NUMBER]") + ->setEmailAddress("member@dropboxsign.com"); + +try { + $result = $faxLineApi->faxLineAddUser($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -63,7 +86,26 @@ Returns a list of available area codes for a given state/province and city ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxLineAreaCodeGet_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); + +try { + $result = $faxLineApi->faxLineAreaCodeGet("US", "CA"); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -104,7 +146,30 @@ Purchases a new Fax Line ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxLineCreate_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); + +$data = new Dropbox\Sign\Model\FaxLineCreateRequest(); +$data->setAreaCode(209) + ->setCountry("US"); + +try { + $result = $faxLineApi->faxLineCreate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -142,7 +207,28 @@ Deletes the specified Fax Line from the subscription. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxLineDelete_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); + +$data = new Dropbox\Sign\Model\FaxLineDeleteRequest(); +$data->setNumber("[FAX_NUMBER]"); + +try { + $faxLineApi->faxLineDelete($data); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -180,7 +266,26 @@ Returns the properties and settings of a Fax Line. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxLineGet_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); + +try { + $result = $faxLineApi->faxLineGet("[FAX_NUMBER]"); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -218,7 +323,26 @@ Returns the properties and settings of multiple Fax Lines. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxLineList_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); + +try { + $result = $faxLineApi->faxLineList(); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -226,8 +350,8 @@ REPLACE_ME_WITH_EXAMPLE_FOR__faxLineList_PHP_CODE |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **account_id** | **string**| Account ID | [optional] | -| **page** | **int**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **page** | **int**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | | **show_team_lines** | **bool**| Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -259,7 +383,30 @@ Removes a user's access to the specified Fax Line ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__faxLineRemoveUser_PHP_CODE +setUsername("YOUR_API_KEY"); + +$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); + +$data = new Dropbox\Sign\Model\FaxLineRemoveUserRequest(); +$data->setNumber("[FAX_NUMBER]") + ->setEmailAddress("member@dropboxsign.com"); + +try { + $result = $faxLineApi->faxLineRemoveUser($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Api/OAuthApi.md b/sdks/php/docs/Api/OAuthApi.md index 451acd420..854b4b7a0 100644 --- a/sdks/php/docs/Api/OAuthApi.md +++ b/sdks/php/docs/Api/OAuthApi.md @@ -20,7 +20,29 @@ Once you have retrieved the code from the user callback, you will need to exchan ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__oauthTokenGenerate_PHP_CODE +setState("900e06e2") + ->setCode("1b0d28d90c86c141") + ->setClientId("cc91c61d00f8bb2ece1428035716b") + ->setClientSecret("1d14434088507ffa390e6f5528465"); + +try { + $result = $oauthApi->oauthTokenGenerate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -58,7 +80,26 @@ Access tokens are only valid for a given period of time (typically one hour) for ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__oauthTokenRefresh_PHP_CODE +setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + +try { + $result = $oauthApi->oauthTokenRefresh($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Api/ReportApi.md b/sdks/php/docs/Api/ReportApi.md index 2c3511cdf..285a20e83 100644 --- a/sdks/php/docs/Api/ReportApi.md +++ b/sdks/php/docs/Api/ReportApi.md @@ -19,7 +19,34 @@ Request the creation of one or more report(s). When the report(s) have been gen ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__reportCreate_PHP_CODE +setUsername("YOUR_API_KEY"); + +$reportApi = new Dropbox\Sign\Api\ReportApi($config); + +$data = new Dropbox\Sign\Model\ReportCreateRequest(); +$data->setStartDate("09/01/2020") + ->setEndDate("09/01/2020") + ->setReportType([ + Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_USER_ACTIVITY, + Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_DOCUMENT_STATUS, + ]); + +try { + $result = $reportApi->reportCreate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Api/SignatureRequestApi.md b/sdks/php/docs/Api/SignatureRequestApi.md index 7edf79879..aa4979035 100644 --- a/sdks/php/docs/Api/SignatureRequestApi.md +++ b/sdks/php/docs/Api/SignatureRequestApi.md @@ -34,7 +34,67 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestBulkCreateEmbeddedWithTemplate_PHP_CODE +setUsername("YOUR_API_KEY"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signerList1Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); +$signerList1Signer->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com") + ->setPin("d79a3td"); + +$signerList1CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); +$signerList1CustomFields->setName("company") + ->setValue("ABC Corp"); + +$signerList1 = new Dropbox\Sign\Model\SubBulkSignerList(); +$signerList1->setSigners([$signerList1Signer]) + ->setCustomFields([$signerList1CustomFields]); + +$signerList2Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); +$signerList2Signer->setRole("Client") + ->setName("Mary") + ->setEmailAddress("mary@example.com") + ->setPin("gd9as5b"); + +$signerList2CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); +$signerList2CustomFields->setName("company") + ->setValue("123 LLC"); + +$signerList2 = new Dropbox\Sign\Model\SubBulkSignerList(); +$signerList2->setSigners([$signerList2Signer]) + ->setCustomFields([$signerList2CustomFields]); + +$cc1 = new Dropbox\Sign\Model\SubCC(); +$cc1->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$data = new Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); +$data->setClientId("1a659d9ad95bccd307ecad78d72192f8") + ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) + ->setSubject("Purchase Order") + ->setMessage("Glad we could come to an agreement.") + ->setSignerList([$signerList1, $signerList2]) + ->setCcs([$cc1]) + ->setTestMode(true); + +try { + $result = $signatureRequestApi->signatureRequestBulkCreateEmbeddedWithTemplate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -72,7 +132,69 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestBulkSendWithTemplate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signerList1Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); +$signerList1Signer->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com") + ->setPin("d79a3td"); + +$signerList1CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); +$signerList1CustomFields->setName("company") + ->setValue("ABC Corp"); + +$signerList1 = new Dropbox\Sign\Model\SubBulkSignerList(); +$signerList1->setSigners([$signerList1Signer]) + ->setCustomFields([$signerList1CustomFields]); + +$signerList2Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); +$signerList2Signer->setRole("Client") + ->setName("Mary") + ->setEmailAddress("mary@example.com") + ->setPin("gd9as5b"); + +$signerList2CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); +$signerList2CustomFields->setName("company") + ->setValue("123 LLC"); + +$signerList2 = new Dropbox\Sign\Model\SubBulkSignerList(); +$signerList2->setSigners([$signerList2Signer]) + ->setCustomFields([$signerList2CustomFields]); + +$cc1 = new Dropbox\Sign\Model\SubCC(); +$cc1->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$data = new Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest(); +$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) + ->setSubject("Purchase Order") + ->setMessage("Glad we could come to an agreement.") + ->setSignerList([$signerList1, $signerList2]) + ->setCcs([$cc1]) + ->setTestMode(true); + +try { + $result = $signatureRequestApi->signatureRequestBulkSendWithTemplate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -110,7 +232,30 @@ Cancels an incomplete signature request. This action is **not reversible**. The ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestCancel_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +try { + $signatureRequestApi->signatureRequestCancel($signatureRequestId); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -148,7 +293,60 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestCreateEmbedded_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); +$signer1->setEmailAddress("jack@example.com") + ->setName("Jack") + ->setOrder(0); + +$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); +$signer2->setEmailAddress("jill@example.com") + ->setName("Jill") + ->setOrder(1); + +$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); +$signingOptions->setDraw(true) + ->setType(true) + ->setUpload(true) + ->setPhone(true) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); + +$data = new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest(); +$data->setClientId("ec64a202072370a737edf4a0eb7f4437") + ->setTitle("NDA with Acme Co.") + ->setSubject("The NDA we talked about") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") + ->setSigners([$signer1, $signer2]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) + ->setSigningOptions($signingOptions) + ->setTestMode(true); + +try { + $result = $signatureRequestApi->signatureRequestCreateEmbedded($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -186,7 +384,50 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestCreateEmbeddedWithTemplate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); +$signer1->setRole("Client") + ->setEmailAddress("george@example.com") + ->setName("George"); + +$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); +$signingOptions->setDraw(true) + ->setType(true) + ->setUpload(true) + ->setPhone(false) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); + +$data = new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest(); +$data->setClientId("ec64a202072370a737edf4a0eb7f4437") + ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) + ->setSubject("Purchase Order") + ->setMessage("Glad we could come to an agreement.") + ->setSigners([$signer1]) + ->setSigningOptions($signingOptions) + ->setTestMode(true); + +try { + $result = $signatureRequestApi->signatureRequestCreateEmbeddedWithTemplate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -224,7 +465,32 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestFiles_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +$fileType = "pdf"; + +try { + $result = $signatureRequestApi->signatureRequestFiles($signatureRequestId, $fileType); + copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -232,7 +498,7 @@ REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestFiles_PHP_CODE |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **signature_request_id** | **string**| The id of the SignatureRequest to retrieve. | | -| **file_type** | **string**| Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] [default to 'pdf'] | +| **file_type** | **string**| Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] [default to 'pdf'] | ### Return type @@ -263,7 +529,31 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestFilesAsDataUri_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +try { + $result = $signatureRequestApi->signatureRequestFilesAsDataUri($signatureRequestId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -301,7 +591,31 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestFilesAsFileUrl_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +try { + $result = $signatureRequestApi->signatureRequestFilesAsFileUrl($signatureRequestId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -309,7 +623,7 @@ REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestFilesAsFileUrl_PHP_CODE |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **signature_request_id** | **string**| The id of the SignatureRequest to retrieve. | | -| **force_download** | **int**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] | +| **force_download** | **int**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] | ### Return type @@ -340,7 +654,31 @@ Returns the status of the SignatureRequest specified by the `signature_request_i ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestGet_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +try { + $result = $signatureRequestApi->signatureRequestGet($signatureRequestId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -378,16 +716,41 @@ Returns a list of SignatureRequests that you can access. This includes Signature ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestList_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$accountId = null; +$page = 1; + +try { + $result = $signatureRequestApi->signatureRequestList($accountId, $page); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **account_id** | **string**| Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] | -| **page** | **int**| Which page number of the SignatureRequest List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **account_id** | **string**| Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] | +| **page** | **int**| Which page number of the SignatureRequest List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | | **query** | **string**| String that includes search terms and/or fields to be used to filter the SignatureRequest objects. | [optional] | ### Return type @@ -419,7 +782,31 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestReleaseHold_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +try { + $result = $signatureRequestApi->signatureRequestReleaseHold($signatureRequestId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -457,7 +844,34 @@ Sends an email to the signer reminding them to sign the signature request. You c ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestRemind_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$data = new Dropbox\Sign\Model\SignatureRequestRemindRequest(); +$data->setEmailAddress("john@example.com"); + +$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +try { + $result = $signatureRequestApi->signatureRequestRemind($signatureRequestId, $data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -496,7 +910,27 @@ Removes your access to a completed signature request. This action is **not rever ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestRemove_PHP_CODE +setUsername("YOUR_API_KEY"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +try { + $signatureRequestApi->signatureRequestRemove($signatureRequestId); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -534,7 +968,67 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestSend_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); +$signer1->setEmailAddress("jack@example.com") + ->setName("Jack") + ->setOrder(0); + +$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); +$signer2->setEmailAddress("jill@example.com") + ->setName("Jill") + ->setOrder(1); + +$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); +$signingOptions->setDraw(true) + ->setType(true) + ->setUpload(true) + ->setPhone(false) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); + +$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); +$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$data = new Dropbox\Sign\Model\SignatureRequestSendRequest(); +$data->setTitle("NDA with Acme Co.") + ->setSubject("The NDA we talked about") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") + ->setSigners([$signer1, $signer2]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) + ->setMetadata([ + "custom_id" => 1234, + "custom_text" => "NDA #9", + ]) + ->setSigningOptions($signingOptions) + ->setFieldOptions($fieldOptions) + ->setTestMode(true); + +try { + $result = $signatureRequestApi->signatureRequestSend($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -572,7 +1066,61 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestSendWithTemplate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); +$signer1->setRole("Client") + ->setEmailAddress("george@example.com") + ->setName("George"); + +$cc1 = new Dropbox\Sign\Model\SubCC(); +$cc1->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$customField1 = new Dropbox\Sign\Model\SubCustomField(); +$customField1->setName("Cost") + ->setValue("$20,000") + ->setEditor("Client") + ->setRequired(true); + +$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); +$signingOptions->setDraw(true) + ->setType(true) + ->setUpload(true) + ->setPhone(false) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); + +$data = new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest(); +$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) + ->setSubject("Purchase Order") + ->setMessage("Glad we could come to an agreement.") + ->setSigners([$signer1]) + ->setCcs([$cc1]) + ->setCustomFields([$customField1]) + ->setSigningOptions($signingOptions) + ->setTestMode(true); + +try { + $result = $signatureRequestApi->signatureRequestSendWithTemplate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -610,7 +1158,35 @@ Updates the email address and/or the name for a given signer on a signature requ ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__signatureRequestUpdate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$data = new Dropbox\Sign\Model\SignatureRequestUpdateRequest(); +$data->setEmailAddress("john@example.com") + ->setSignatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); + +$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +try { + $result = $signatureRequestApi->signatureRequestUpdate($signatureRequestId, $data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Api/TeamApi.md b/sdks/php/docs/Api/TeamApi.md index 22565853c..1f46c6b3f 100644 --- a/sdks/php/docs/Api/TeamApi.md +++ b/sdks/php/docs/Api/TeamApi.md @@ -28,7 +28,32 @@ Invites a user (specified using the `email_address` parameter) to your Team. If ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__teamAddMember_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$teamApi = new Dropbox\Sign\Api\TeamApi($config); + +$data = new Dropbox\Sign\Model\TeamAddMemberRequest(); +$data->setEmailAddress("george@example.com"); + +try { + $result = $teamApi->teamAddMember($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -67,7 +92,32 @@ Creates a new Team and makes you a member. You must not currently belong to a Te ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__teamCreate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$teamApi = new Dropbox\Sign\Api\TeamApi($config); + +$data = new Dropbox\Sign\Model\TeamCreateRequest(); +$data->setName("New Team Name"); + +try { + $result = $teamApi->teamCreate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -105,7 +155,28 @@ Deletes your Team. Can only be invoked when you have a Team with only one member ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__teamDelete_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$teamApi = new Dropbox\Sign\Api\TeamApi($config); + +try { + $teamApi->teamDelete(); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -141,7 +212,29 @@ Returns information about your Team as well as a list of its members. If you do ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__teamGet_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$teamApi = new Dropbox\Sign\Api\TeamApi($config); + +try { + $result = $teamApi->teamGet(); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -177,7 +270,29 @@ Provides information about a team. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__teamInfo_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$teamApi = new Dropbox\Sign\Api\TeamApi($config); + +try { + $result = $teamApi->teamInfo(); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -215,7 +330,31 @@ Provides a list of team invites (and their roles). ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__teamInvites_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$teamApi = new Dropbox\Sign\Api\TeamApi($config); + +$emailAddress = "user@dropboxsign.com"; + +try { + $result = $teamApi->teamInvites($emailAddress); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -253,7 +392,31 @@ Provides a paginated list of members (and their roles) that belong to a given te ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__teamMembers_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$teamApi = new Dropbox\Sign\Api\TeamApi($config); + +$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; + +try { + $result = $teamApi->teamMembers($teamId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -261,8 +424,8 @@ REPLACE_ME_WITH_EXAMPLE_FOR__teamMembers_PHP_CODE |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **team_id** | **string**| The id of the team that a member list is being requested from. | | -| **page** | **int**| Which page number of the team member list to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **page** | **int**| Which page number of the team member list to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -293,7 +456,33 @@ Removes the provided user Account from your Team. If the Account had an outstand ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__teamRemoveMember_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$teamApi = new Dropbox\Sign\Api\TeamApi($config); + +$data = new Dropbox\Sign\Model\TeamRemoveMemberRequest(); +$data->setEmailAddress("teammate@dropboxsign.com") + ->setNewOwnerEmailAddress("new_teammate@dropboxsign.com"); + +try { + $result = $teamApi->teamRemoveMember($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -331,7 +520,31 @@ Provides a paginated list of sub teams that belong to a given team. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__teamSubTeams_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$teamApi = new Dropbox\Sign\Api\TeamApi($config); + +$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; + +try { + $result = $teamApi->teamSubTeams($teamId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -339,8 +552,8 @@ REPLACE_ME_WITH_EXAMPLE_FOR__teamSubTeams_PHP_CODE |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **team_id** | **string**| The id of the parent Team. | | -| **page** | **int**| Which page number of the SubTeam List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **page** | **int**| Which page number of the SubTeam List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -371,7 +584,32 @@ Updates the name of your Team. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__teamUpdate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$teamApi = new Dropbox\Sign\Api\TeamApi($config); + +$data = new Dropbox\Sign\Model\TeamUpdateRequest(); +$data->setName("New Team Name"); + +try { + $result = $teamApi->teamUpdate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Api/TemplateApi.md b/sdks/php/docs/Api/TemplateApi.md index 99d1c4d4e..5381a8290 100644 --- a/sdks/php/docs/Api/TemplateApi.md +++ b/sdks/php/docs/Api/TemplateApi.md @@ -29,7 +29,34 @@ Gives the specified Account access to the specified Template. The specified Acco ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateAddUser_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$data = new Dropbox\Sign\Model\TemplateAddUserRequest(); +$data->setEmailAddress("george@dropboxsign.com"); + +$templateId = "f57db65d3f933b5316d398057a36176831451a35"; + +try { + $result = $templateApi->templateAddUser($templateId, $data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -68,7 +95,60 @@ Creates a template that can then be used. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateCreate_PHP_CODE +setUsername('YOUR_API_KEY'); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$role1 = new Dropbox\Sign\Model\SubTemplateRole(); +$role1->setName('Client') + ->setOrder(0); + +$role2 = new Dropbox\Sign\Model\SubTemplateRole(); +$role2->setName('Witness') + ->setOrder(1); + +$mergeField1 = new Dropbox\Sign\Model\SubMergeField(); +$mergeField1->setName('Full Name') + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$mergeField2 = new Dropbox\Sign\Model\SubMergeField(); +$mergeField2->setName('Is Registered?') + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); +$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$data = new Dropbox\Sign\Model\TemplateCreateRequest(); +$data->setClientId('37dee8d8440c66d54cfa05d92c160882') + ->setFiles([new SplFileObject(__DIR__ . '/example_signature_request.pdf')]) + ->setTitle('Test Template') + ->setSubject('Please sign this document') + ->setMessage('For your approval') + ->setSignerRoles([$role1, $role2]) + ->setCcRoles(['Manager']) + ->setMergeFields([$mergeField1, $mergeField2]) + ->setFieldOptions($fieldOptions) + ->setTestMode(true); + +try { + $result = $templateApi->templateCreate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo 'Exception when calling Dropbox Sign API: ' + . print_r($error->getError()); +} + ``` ### Parameters @@ -106,7 +186,60 @@ The first step in an embedded template workflow. Creates a draft template that c ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateCreateEmbeddedDraft_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$role1 = new Dropbox\Sign\Model\SubTemplateRole(); +$role1->setName("Client") + ->setOrder(0); + +$role2 = new Dropbox\Sign\Model\SubTemplateRole(); +$role2->setName("Witness") + ->setOrder(1); + +$mergeField1 = new Dropbox\Sign\Model\SubMergeField(); +$mergeField1->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$mergeField2 = new Dropbox\Sign\Model\SubMergeField(); +$mergeField2->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); +$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$data = new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest(); +$data->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) + ->setTitle("Test Template") + ->setSubject("Please sign this document") + ->setMessage("For your approval") + ->setSignerRoles([$role1, $role2]) + ->setCcRoles(["Manager"]) + ->setMergeFields([$mergeField1, $mergeField2]) + ->setFieldOptions($fieldOptions) + ->setTestMode(true); + +try { + $result = $templateApi->templateCreateEmbeddedDraft($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -144,7 +277,30 @@ Completely deletes the template specified from the account. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateDelete_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$templateId = "5de8179668f2033afac48da1868d0093bf133266"; + +try { + $templateApi->templateDelete($templateId); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -182,7 +338,32 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateFiles_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$templateId = "5de8179668f2033afac48da1868d0093bf133266"; +$fileType = "pdf"; + +try { + $result = $templateApi->templateFiles($templateId, $fileType); + copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -190,7 +371,7 @@ REPLACE_ME_WITH_EXAMPLE_FOR__templateFiles_PHP_CODE |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **template_id** | **string**| The id of the template files to retrieve. | | -| **file_type** | **string**| Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] | +| **file_type** | **string**| Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] | ### Return type @@ -221,7 +402,31 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateFilesAsDataUri_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$templateId = "5de8179668f2033afac48da1868d0093bf133266"; + +try { + $result = $templateApi->templateFilesAsDataUri($templateId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -259,7 +464,31 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateFilesAsFileUrl_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$templateId = "5de8179668f2033afac48da1868d0093bf133266"; + +try { + $result = $templateApi->templateFilesAsFileUrl($templateId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -267,7 +496,7 @@ REPLACE_ME_WITH_EXAMPLE_FOR__templateFilesAsFileUrl_PHP_CODE |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **template_id** | **string**| The id of the template files to retrieve. | | -| **force_download** | **int**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] | +| **force_download** | **int**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] | ### Return type @@ -298,7 +527,31 @@ Returns the Template specified by the `template_id` parameter. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateGet_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$templateId = "f57db65d3f933b5316d398057a36176831451a35"; + +try { + $result = $templateApi->templateGet($templateId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -336,16 +589,40 @@ Returns a list of the Templates that are accessible by you. Take a look at our ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateList_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$accountId = "f57db65d3f933b5316d398057a36176831451a35"; + +try { + $result = $templateApi->templateList($accountId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **account_id** | **string**| Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] | -| **page** | **int**| Which page number of the Template List to return. Defaults to `1`. | [optional] [default to 1] | -| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **account_id** | **string**| Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] | +| **page** | **int**| Which page number of the Template List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | | **query** | **string**| String that includes search terms and/or fields to be used to filter the Template objects. | [optional] | ### Return type @@ -377,7 +654,34 @@ Removes the specified Account's access to the specified Template. ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateRemoveUser_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$data = new Dropbox\Sign\Model\TemplateRemoveUserRequest(); +$data->setEmailAddress("george@dropboxsign.com"); + +$templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; + +try { + $result = $templateApi->templateRemoveUser($templateId, $data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -416,7 +720,34 @@ Overlays a new file with the overlay of an existing template. The new file(s) mu ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__templateUpdateFiles_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$templateApi = new Dropbox\Sign\Api\TemplateApi($config); + +$data = new Dropbox\Sign\Model\TemplateUpdateFilesRequest(); +$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]); + +$templateId = "5de8179668f2033afac48da1868d0093bf133266"; + +try { + $result = $templateApi->templateUpdateFiles($templateId, $data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Api/UnclaimedDraftApi.md b/sdks/php/docs/Api/UnclaimedDraftApi.md index b0f32a1c2..a2b2f4236 100644 --- a/sdks/php/docs/Api/UnclaimedDraftApi.md +++ b/sdks/php/docs/Api/UnclaimedDraftApi.md @@ -22,7 +22,67 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__unclaimedDraftCreate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); + +$signer1 = new Dropbox\Sign\Model\SubUnclaimedDraftSigner(); +$signer1->setEmailAddress("jack@example.com") + ->setName("Jack") + ->setOrder(0); + +$signer2 = new Dropbox\Sign\Model\SubUnclaimedDraftSigner(); +$signer2->setEmailAddress("jill@example.com") + ->setName("Jill") + ->setOrder(1); + +$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); +$signingOptions->setDraw(true) + ->setType(true) + ->setUpload(true) + ->setPhone(false) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); + +$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); +$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$data = new Dropbox\Sign\Model\UnclaimedDraftCreateRequest(); +$data->setSubject("The NDA we talked about") + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") + ->setSigners([$signer1, $signer2]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) + ->setMetadata([ + "custom_id" => 1234, + "custom_text" => "NDA #9", + ]) + ->setSigningOptions($signingOptions) + ->setFieldOptions($fieldOptions) + ->setTestMode(true); + +try { + $result = $unclaimedDraftApi->unclaimedDraftCreate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -60,7 +120,35 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__unclaimedDraftCreateEmbedded_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); + +$data = new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest(); +$data->setClientId("ec64a202072370a737edf4a0eb7f4437") + ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(true); + +try { + $result = $unclaimedDraftApi->unclaimedDraftCreateEmbedded($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -98,7 +186,46 @@ Creates a new Draft with a previously saved template(s) that can be claimed and ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__unclaimedDraftCreateEmbeddedWithTemplate_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); + +$signer1 = new Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner(); +$signer1->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$cc1 = new Dropbox\Sign\Model\SubCC(); +$cc1->setRole("Accounting") + ->setEmailAddress("accounting@dropboxsign.com"); + +$data = new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest(); +$data->setClientId("ec64a202072370a737edf4a0eb7f4437") + ->setTemplateIds(["61a832ff0d8423f91d503e76bfbcc750f7417c78"]) + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setSigners([$signer1]) + ->setCcs([$cc1]) + ->setTestMode(true); + +try { + $result = $unclaimedDraftApi->unclaimedDraftCreateEmbeddedWithTemplate($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters @@ -136,7 +263,35 @@ Creates a new signature request from an embedded request that can be edited prio ### Example ```php -REPLACE_ME_WITH_EXAMPLE_FOR__unclaimedDraftEditAndResend_PHP_CODE +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); + +$data = new Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest(); +$data->setClientId("ec64a202072370a737edf4a0eb7f4437") + ->setTestMode(true); + +$signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; + +try { + $result = $unclaimedDraftApi->unclaimedDraftEditAndResend($signatureRequestId, $data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + ``` ### Parameters diff --git a/sdks/php/docs/Model/AccountCreateRequest.md b/sdks/php/docs/Model/AccountCreateRequest.md index d6c2fda2b..4fb7caf90 100644 --- a/sdks/php/docs/Model/AccountCreateRequest.md +++ b/sdks/php/docs/Model/AccountCreateRequest.md @@ -6,13 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address which will be associated with the new Account. REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Used when creating a new account with OAuth authorization. - -See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_secret` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Used when creating a new account with OAuth authorization. - -See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) REPLACE_ME_WITH_DESCRIPTION_END | | -| `locale` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address`*_required_ | ```string``` | The email address which will be associated with the new Account. | | +| `client_id` | ```string``` | Used when creating a new account with OAuth authorization.

See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | | +| `client_secret` | ```string``` | Used when creating a new account with OAuth authorization.

See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | | +| `locale` | ```string``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountCreateResponse.md b/sdks/php/docs/Model/AccountCreateResponse.md index 68f31c87a..bf38de482 100644 --- a/sdks/php/docs/Model/AccountCreateResponse.md +++ b/sdks/php/docs/Model/AccountCreateResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account`*_required_ | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `oauth_data` | [```\Dropbox\Sign\Model\OAuthTokenResponse```](OAuthTokenResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `account`*_required_ | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | | | +| `oauth_data` | [```\Dropbox\Sign\Model\OAuthTokenResponse```](OAuthTokenResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountGetResponse.md b/sdks/php/docs/Model/AccountGetResponse.md index 0ba684643..e7cecaf5d 100644 --- a/sdks/php/docs/Model/AccountGetResponse.md +++ b/sdks/php/docs/Model/AccountGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account`*_required_ | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `account`*_required_ | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponse.md b/sdks/php/docs/Model/AccountResponse.md index acefb359a..3121826ba 100644 --- a/sdks/php/docs/Model/AccountResponse.md +++ b/sdks/php/docs/Model/AccountResponse.md @@ -6,16 +6,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The ID of the Account REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address associated with the Account. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_locked` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has been locked out of their account by a team admin. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_paid_hs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has a paid Dropbox Sign account. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_paid_hf` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has a paid HelloFax account. REPLACE_ME_WITH_DESCRIPTION_END | | -| `quotas` | [```\Dropbox\Sign\Model\AccountResponseQuotas```](AccountResponseQuotas.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL that Dropbox Sign events will `POST` to. REPLACE_ME_WITH_DESCRIPTION_END | | -| `role_code` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The membership role for the team. REPLACE_ME_WITH_DESCRIPTION_END | | -| `team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the team account belongs to. REPLACE_ME_WITH_DESCRIPTION_END | | -| `locale` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. REPLACE_ME_WITH_DESCRIPTION_END | | -| `usage` | [```\Dropbox\Sign\Model\AccountResponseUsage```](AccountResponseUsage.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | The ID of the Account | | +| `email_address` | ```string``` | The email address associated with the Account. | | +| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas` | [```\Dropbox\Sign\Model\AccountResponseQuotas```](AccountResponseQuotas.md) | | | +| `callback_url` | ```string``` | The URL that Dropbox Sign events will `POST` to. | | +| `role_code` | ```string``` | The membership role for the team. | | +| `team_id` | ```string``` | The id of the team account belongs to. | | +| `locale` | ```string``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | +| `usage` | [```\Dropbox\Sign\Model\AccountResponseUsage```](AccountResponseUsage.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponseQuotas.md b/sdks/php/docs/Model/AccountResponseQuotas.md index e7b4f28ee..96399403d 100644 --- a/sdks/php/docs/Model/AccountResponseQuotas.md +++ b/sdks/php/docs/Model/AccountResponseQuotas.md @@ -6,11 +6,11 @@ Details concerning remaining monthly quotas. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_signature_requests_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN API signature requests remaining. REPLACE_ME_WITH_DESCRIPTION_END | | -| `documents_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signature requests remaining. REPLACE_ME_WITH_DESCRIPTION_END | | -| `templates_total` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Total API templates allowed. REPLACE_ME_WITH_DESCRIPTION_END | | -| `templates_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN API templates remaining. REPLACE_ME_WITH_DESCRIPTION_END | | -| `sms_verifications_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN SMS verifications remaining. REPLACE_ME_WITH_DESCRIPTION_END | | -| `num_fax_pages_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of fax pages left REPLACE_ME_WITH_DESCRIPTION_END | | +| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | +| `documents_left` | ```int``` | Signature requests remaining. | | +| `templates_total` | ```int``` | Total API templates allowed. | | +| `templates_left` | ```int``` | API templates remaining. | | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | +| `num_fax_pages_left` | ```int``` | Number of fax pages left | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponseUsage.md b/sdks/php/docs/Model/AccountResponseUsage.md index a109569d1..3d8c992c2 100644 --- a/sdks/php/docs/Model/AccountResponseUsage.md +++ b/sdks/php/docs/Model/AccountResponseUsage.md @@ -6,6 +6,6 @@ Details concerning monthly usage Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_pages_sent` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of fax pages sent REPLACE_ME_WITH_DESCRIPTION_END | | +| `fax_pages_sent` | ```int``` | Number of fax pages sent | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountUpdateRequest.md b/sdks/php/docs/Model/AccountUpdateRequest.md index afe735eba..2eb446a53 100644 --- a/sdks/php/docs/Model/AccountUpdateRequest.md +++ b/sdks/php/docs/Model/AccountUpdateRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The ID of the Account REPLACE_ME_WITH_DESCRIPTION_END | | -| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL that Dropbox Sign should POST events to. REPLACE_ME_WITH_DESCRIPTION_END | | -| `locale` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | The ID of the Account | | +| `callback_url` | ```string``` | The URL that Dropbox Sign should POST events to. | | +| `locale` | ```string``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountVerifyRequest.md b/sdks/php/docs/Model/AccountVerifyRequest.md index bba185a2f..756432934 100644 --- a/sdks/php/docs/Model/AccountVerifyRequest.md +++ b/sdks/php/docs/Model/AccountVerifyRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address to run the verification for. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address`*_required_ | ```string``` | Email address to run the verification for. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountVerifyResponse.md b/sdks/php/docs/Model/AccountVerifyResponse.md index da56a594a..6e7849d15 100644 --- a/sdks/php/docs/Model/AccountVerifyResponse.md +++ b/sdks/php/docs/Model/AccountVerifyResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account` | [```\Dropbox\Sign\Model\AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `account` | [```\Dropbox\Sign\Model\AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountVerifyResponseAccount.md b/sdks/php/docs/Model/AccountVerifyResponseAccount.md index 4970f76b7..ce3508004 100644 --- a/sdks/php/docs/Model/AccountVerifyResponseAccount.md +++ b/sdks/php/docs/Model/AccountVerifyResponseAccount.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address associated with the Account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | The email address associated with the Account. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppCreateRequest.md b/sdks/php/docs/Model/ApiAppCreateRequest.md index ee6f11989..09a285a60 100644 --- a/sdks/php/docs/Model/ApiAppCreateRequest.md +++ b/sdks/php/docs/Model/ApiAppCreateRequest.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `domains`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The domain names the ApiApp will be associated with. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name you want to assign to the ApiApp. REPLACE_ME_WITH_DESCRIPTION_END | | -| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL at which the ApiApp should receive event callbacks. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_logo_file` | ```\SplFileObject``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) REPLACE_ME_WITH_DESCRIPTION_END | | -| `oauth` | [```\Dropbox\Sign\Model\SubOAuth```](SubOAuth.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `options` | [```\Dropbox\Sign\Model\SubOptions```](SubOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `white_labeling_options` | [```\Dropbox\Sign\Model\SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `domains`*_required_ | ```string[]``` | The domain names the ApiApp will be associated with. | | +| `name`*_required_ | ```string``` | The name you want to assign to the ApiApp. | | +| `callback_url` | ```string``` | The URL at which the ApiApp should receive event callbacks. | | +| `custom_logo_file` | ```\SplFileObject``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | | +| `oauth` | [```\Dropbox\Sign\Model\SubOAuth```](SubOAuth.md) | | | +| `options` | [```\Dropbox\Sign\Model\SubOptions```](SubOptions.md) | | | +| `white_labeling_options` | [```\Dropbox\Sign\Model\SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppGetResponse.md b/sdks/php/docs/Model/ApiAppGetResponse.md index 3149cb511..b47e35c20 100644 --- a/sdks/php/docs/Model/ApiAppGetResponse.md +++ b/sdks/php/docs/Model/ApiAppGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_app`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse```](ApiAppResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `api_app`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse```](ApiAppResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppListResponse.md b/sdks/php/docs/Model/ApiAppListResponse.md index 94fdceb29..2eb8ae3c9 100644 --- a/sdks/php/docs/Model/ApiAppListResponse.md +++ b/sdks/php/docs/Model/ApiAppListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_apps`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse[]```](ApiAppResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains information about API Apps. REPLACE_ME_WITH_DESCRIPTION_END | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `api_apps`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse[]```](ApiAppResponse.md) | Contains information about API Apps. | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponse.md b/sdks/php/docs/Model/ApiAppResponse.md index 5605e6937..975df4b5c 100644 --- a/sdks/php/docs/Model/ApiAppResponse.md +++ b/sdks/php/docs/Model/ApiAppResponse.md @@ -6,15 +6,15 @@ Contains information about an API App. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The app's callback URL (for events) REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The app's client id REPLACE_ME_WITH_DESCRIPTION_END | | -| `created_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The time that the app was created REPLACE_ME_WITH_DESCRIPTION_END | | -| `domains` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The domain name(s) associated with the app REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the app REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_approved` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean to indicate if the app has been approved REPLACE_ME_WITH_DESCRIPTION_END | | -| `oauth` | [```\Dropbox\Sign\Model\ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `options` | [```\Dropbox\Sign\Model\ApiAppResponseOptions```](ApiAppResponseOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `owner_account` | [```\Dropbox\Sign\Model\ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `white_labeling_options` | [```\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `callback_url` | ```string``` | The app's callback URL (for events) | | +| `client_id` | ```string``` | The app's client id | | +| `created_at` | ```int``` | The time that the app was created | | +| `domains` | ```string[]``` | The domain name(s) associated with the app | | +| `name` | ```string``` | The name of the app | | +| `is_approved` | ```bool``` | Boolean to indicate if the app has been approved | | +| `oauth` | [```\Dropbox\Sign\Model\ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | +| `options` | [```\Dropbox\Sign\Model\ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `owner_account` | [```\Dropbox\Sign\Model\ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | +| `white_labeling_options` | [```\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseOAuth.md b/sdks/php/docs/Model/ApiAppResponseOAuth.md index b3b82aa32..f6010fe20 100644 --- a/sdks/php/docs/Model/ApiAppResponseOAuth.md +++ b/sdks/php/docs/Model/ApiAppResponseOAuth.md @@ -6,9 +6,9 @@ An object describing the app's OAuth properties, or null if OAuth is not con Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The app's OAuth callback URL. REPLACE_ME_WITH_DESCRIPTION_END | | -| `secret` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The app's OAuth secret, or null if the app does not belong to user. REPLACE_ME_WITH_DESCRIPTION_END | | -| `scopes` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Array of OAuth scopes used by the app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `charges_users` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. REPLACE_ME_WITH_DESCRIPTION_END | | +| `callback_url` | ```string``` | The app's OAuth callback URL. | | +| `secret` | ```string``` | The app's OAuth secret, or null if the app does not belong to user. | | +| `scopes` | ```string[]``` | Array of OAuth scopes used by the app. | | +| `charges_users` | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseOptions.md b/sdks/php/docs/Model/ApiAppResponseOptions.md index 7317d847a..872e8ed0f 100644 --- a/sdks/php/docs/Model/ApiAppResponseOptions.md +++ b/sdks/php/docs/Model/ApiAppResponseOptions.md @@ -6,6 +6,6 @@ An object with options that override account settings. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean denoting if signers can "Insert Everywhere" in one click while signing a document REPLACE_ME_WITH_DESCRIPTION_END | | +| `can_insert_everywhere` | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md b/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md index f7e40e40b..8f1ce1963 100644 --- a/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md +++ b/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md @@ -6,7 +6,7 @@ An object describing the app's owner Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The owner account's ID REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The owner account's email address REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | The owner account's ID | | +| `email_address` | ```string``` | The owner account's email address | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md b/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md index cdf8fd643..6e963383c 100644 --- a/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md @@ -6,19 +6,19 @@ An object with options to customize the app's signer page Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `header_background_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `legal_version` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `link_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `page_background_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `primary_button_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `primary_button_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `primary_button_text_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `primary_button_text_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `secondary_button_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `secondary_button_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `secondary_button_text_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `secondary_button_text_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `text_color1` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `text_color2` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `header_background_color` | ```string``` | | | +| `legal_version` | ```string``` | | | +| `link_color` | ```string``` | | | +| `page_background_color` | ```string``` | | | +| `primary_button_color` | ```string``` | | | +| `primary_button_color_hover` | ```string``` | | | +| `primary_button_text_color` | ```string``` | | | +| `primary_button_text_color_hover` | ```string``` | | | +| `secondary_button_color` | ```string``` | | | +| `secondary_button_color_hover` | ```string``` | | | +| `secondary_button_text_color` | ```string``` | | | +| `secondary_button_text_color_hover` | ```string``` | | | +| `text_color1` | ```string``` | | | +| `text_color2` | ```string``` | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppUpdateRequest.md b/sdks/php/docs/Model/ApiAppUpdateRequest.md index 780a08985..b20923db0 100644 --- a/sdks/php/docs/Model/ApiAppUpdateRequest.md +++ b/sdks/php/docs/Model/ApiAppUpdateRequest.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL at which the API App should receive event callbacks. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_logo_file` | ```\SplFileObject``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) REPLACE_ME_WITH_DESCRIPTION_END | | -| `domains` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The domain names the ApiApp will be associated with. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name you want to assign to the ApiApp. REPLACE_ME_WITH_DESCRIPTION_END | | -| `oauth` | [```\Dropbox\Sign\Model\SubOAuth```](SubOAuth.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `options` | [```\Dropbox\Sign\Model\SubOptions```](SubOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `white_labeling_options` | [```\Dropbox\Sign\Model\SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `callback_url` | ```string``` | The URL at which the API App should receive event callbacks. | | +| `custom_logo_file` | ```\SplFileObject``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | | +| `domains` | ```string[]``` | The domain names the ApiApp will be associated with. | | +| `name` | ```string``` | The name you want to assign to the ApiApp. | | +| `oauth` | [```\Dropbox\Sign\Model\SubOAuth```](SubOAuth.md) | | | +| `options` | [```\Dropbox\Sign\Model\SubOptions```](SubOptions.md) | | | +| `white_labeling_options` | [```\Dropbox\Sign\Model\SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobGetResponse.md b/sdks/php/docs/Model/BulkSendJobGetResponse.md index ecf455dcd..ec44f5b9a 100644 --- a/sdks/php/docs/Model/BulkSendJobGetResponse.md +++ b/sdks/php/docs/Model/BulkSendJobGetResponse.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse```](BulkSendJobResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[]```](BulkSendJobGetResponseSignatureRequests.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains information about the Signature Requests sent in bulk. REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `bulk_send_job`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse```](BulkSendJobResponse.md) | | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | +| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[]```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md b/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md index b03c52baa..247951d28 100644 --- a/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md @@ -6,33 +6,30 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `signature_request_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `requester_email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the initiator of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title the specified Account uses for the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `original_title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Default Label for account. REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that was initially sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that was initially sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The metadata attached to the signature request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `created_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time the signature request was created. REPLACE_ME_WITH_DESCRIPTION_END | | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_complete` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not the SignatureRequest has been fully executed by all signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_declined` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not the SignatureRequest has been declined by a signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `has_error` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). REPLACE_ME_WITH_DESCRIPTION_END | | -| `files_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where a copy of the request's documents can be downloaded. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. REPLACE_ME_WITH_DESCRIPTION_END | | -| `details_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where the requester and the signers can view the current status of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want the signer redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `final_copy_uri` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The path where the completed document can be downloaded REPLACE_ME_WITH_DESCRIPTION_END | | -| `template_ids` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Templates IDs used in this SignatureRequest (if any). REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of Custom Field objects containing the name and type of each custom field. - -* Text Field uses `SignatureRequestResponseCustomFieldText` -* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` REPLACE_ME_WITH_DESCRIPTION_END | | -| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signer attachments. REPLACE_ME_WITH_DESCRIPTION_END | | -| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of signature objects, 1 for each signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `bulk_send_job_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the BulkSendJob. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to false] | +| `signature_request_id` | ```string``` | The id of the SignatureRequest. | | +| `requester_email_address` | ```string``` | The email address of the initiator of the SignatureRequest. | | +| `title` | ```string``` | The title the specified Account uses for the SignatureRequest. | | +| `original_title` | ```string``` | Default Label for account. | | +| `subject` | ```string``` | The subject in the email that was initially sent to the signers. | | +| `message` | ```string``` | The custom message in the email that was initially sent to the signers. | | +| `metadata` | ```array``` | The metadata attached to the signature request. | | +| `created_at` | ```int``` | Time the signature request was created. | | +| `expires_at` | ```int``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `is_complete` | ```bool``` | Whether or not the SignatureRequest has been fully executed by all signers. | | +| `is_declined` | ```bool``` | Whether or not the SignatureRequest has been declined by a signer. | | +| `has_error` | ```bool``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | +| `files_url` | ```string``` | The URL where a copy of the request's documents can be downloaded. | | +| `signing_url` | ```string``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | +| `details_url` | ```string``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | +| `cc_email_addresses` | ```string[]``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | +| `signing_redirect_url` | ```string``` | The URL you want the signer redirected to after they successfully sign. | | +| `final_copy_uri` | ```string``` | The path where the completed document can be downloaded | | +| `template_ids` | ```string[]``` | Templates IDs used in this SignatureRequest (if any). | | +| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | +| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | +| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | +| `bulk_send_job_id` | ```string``` | The id of the BulkSendJob. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobListResponse.md b/sdks/php/docs/Model/BulkSendJobListResponse.md index be193114d..470448cd9 100644 --- a/sdks/php/docs/Model/BulkSendJobListResponse.md +++ b/sdks/php/docs/Model/BulkSendJobListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_jobs`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse[]```](BulkSendJobResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains a list of BulkSendJobs that the API caller has access to. REPLACE_ME_WITH_DESCRIPTION_END | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `bulk_send_jobs`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse[]```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobResponse.md b/sdks/php/docs/Model/BulkSendJobResponse.md index 596281b1d..16194fdd3 100644 --- a/sdks/php/docs/Model/BulkSendJobResponse.md +++ b/sdks/php/docs/Model/BulkSendJobResponse.md @@ -6,9 +6,9 @@ Contains information about the BulkSendJob such as when it was created and how m Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the BulkSendJob. REPLACE_ME_WITH_DESCRIPTION_END | | -| `total` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The total amount of Signature Requests queued for sending. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_creator` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. REPLACE_ME_WITH_DESCRIPTION_END | | -| `created_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time that the BulkSendJob was created. REPLACE_ME_WITH_DESCRIPTION_END | | +| `bulk_send_job_id` | ```string``` | The id of the BulkSendJob. | | +| `total` | ```int``` | The total amount of Signature Requests queued for sending. | | +| `is_creator` | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `created_at` | ```int``` | Time that the BulkSendJob was created. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobSendResponse.md b/sdks/php/docs/Model/BulkSendJobSendResponse.md index ee1575bbc..83f1c7f8b 100644 --- a/sdks/php/docs/Model/BulkSendJobSendResponse.md +++ b/sdks/php/docs/Model/BulkSendJobSendResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse```](BulkSendJobResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `bulk_send_job`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse```](BulkSendJobResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedEditUrlRequest.md b/sdks/php/docs/Model/EmbeddedEditUrlRequest.md index 97ae9ddb8..ad008f66e 100644 --- a/sdks/php/docs/Model/EmbeddedEditUrlRequest.md +++ b/sdks/php/docs/Model/EmbeddedEditUrlRequest.md @@ -6,19 +6,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `allow_edit_ccs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable/disable to add or change CC roles when editing the template. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `cc_roles` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `force_signer_roles` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template signer roles. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `force_subject_message` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template subject and message. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. - -Remove all merge fields on the template by passing an empty array `[]`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `preview_only` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). - -**NOTE:** This parameter overwrites `show_preview=true` (if set). REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `show_preview` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the editor/preview experience. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `allow_edit_ccs` | ```bool``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to false] | +| `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | +| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | +| `force_signer_roles` | ```bool``` | Provide users the ability to review/edit the template signer roles. | [default to false] | +| `force_subject_message` | ```bool``` | Provide users the ability to review/edit the template subject and message. | [default to false] | +| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.

Remove all merge fields on the template by passing an empty array `[]`. | | +| `preview_only` | ```bool``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

**NOTE:** This parameter overwrites `show_preview=true` (if set). | [default to false] | +| `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience. | [default to false] | +| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | +| `test_mode` | ```bool``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedEditUrlResponse.md b/sdks/php/docs/Model/EmbeddedEditUrlResponse.md index a4aaf8150..75b539197 100644 --- a/sdks/php/docs/Model/EmbeddedEditUrlResponse.md +++ b/sdks/php/docs/Model/EmbeddedEditUrlResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `embedded`*_required_ | [```\Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `embedded`*_required_ | [```\Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md b/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md index cf95c29d6..03d32b4ef 100644 --- a/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md +++ b/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md @@ -6,7 +6,7 @@ An embedded template object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `edit_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A template url that can be opened in an iFrame. REPLACE_ME_WITH_DESCRIPTION_END | | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The specific time that the the `edit_url` link expires, in epoch. REPLACE_ME_WITH_DESCRIPTION_END | | +| `edit_url` | ```string``` | A template url that can be opened in an iFrame. | | +| `expires_at` | ```int``` | The specific time that the the `edit_url` link expires, in epoch. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedSignUrlResponse.md b/sdks/php/docs/Model/EmbeddedSignUrlResponse.md index a60c2496e..bbf44ed90 100644 --- a/sdks/php/docs/Model/EmbeddedSignUrlResponse.md +++ b/sdks/php/docs/Model/EmbeddedSignUrlResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `embedded`*_required_ | [```\Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `embedded`*_required_ | [```\Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md b/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md index 76480e653..a3794eb9e 100644 --- a/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md +++ b/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md @@ -6,7 +6,7 @@ An object that contains necessary information to set up embedded signing. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `sign_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A signature url that can be opened in an iFrame. REPLACE_ME_WITH_DESCRIPTION_END | | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The specific time that the the `sign_url` link expires, in epoch. REPLACE_ME_WITH_DESCRIPTION_END | | +| `sign_url` | ```string``` | A signature url that can be opened in an iFrame. | | +| `expires_at` | ```int``` | The specific time that the the `sign_url` link expires, in epoch. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ErrorResponse.md b/sdks/php/docs/Model/ErrorResponse.md index 5f4f504a3..bfc306713 100644 --- a/sdks/php/docs/Model/ErrorResponse.md +++ b/sdks/php/docs/Model/ErrorResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `error`*_required_ | [```\Dropbox\Sign\Model\ErrorResponseError```](ErrorResponseError.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `error`*_required_ | [```\Dropbox\Sign\Model\ErrorResponseError```](ErrorResponseError.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ErrorResponseError.md b/sdks/php/docs/Model/ErrorResponseError.md index d650d22e6..b600e94c8 100644 --- a/sdks/php/docs/Model/ErrorResponseError.md +++ b/sdks/php/docs/Model/ErrorResponseError.md @@ -6,8 +6,8 @@ Contains information about an error that occurred. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `error_msg`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Message describing an error. REPLACE_ME_WITH_DESCRIPTION_END | | -| `error_name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Name of the error. REPLACE_ME_WITH_DESCRIPTION_END | | -| `error_path` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Path at which an error occurred. REPLACE_ME_WITH_DESCRIPTION_END | | +| `error_msg`*_required_ | ```string``` | Message describing an error. | | +| `error_name`*_required_ | ```string``` | Name of the error. | | +| `error_path` | ```string``` | Path at which an error occurred. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EventCallbackRequest.md b/sdks/php/docs/Model/EventCallbackRequest.md index 6a2bfb545..aeac7154b 100644 --- a/sdks/php/docs/Model/EventCallbackRequest.md +++ b/sdks/php/docs/Model/EventCallbackRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `event`*_required_ | [```\Dropbox\Sign\Model\EventCallbackRequestEvent```](EventCallbackRequestEvent.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `account` | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `signature_request` | [```\Dropbox\Sign\Model\SignatureRequestResponse```](SignatureRequestResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `template` | [```\Dropbox\Sign\Model\TemplateResponse```](TemplateResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `event`*_required_ | [```\Dropbox\Sign\Model\EventCallbackRequestEvent```](EventCallbackRequestEvent.md) | | | +| `account` | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | | | +| `signature_request` | [```\Dropbox\Sign\Model\SignatureRequestResponse```](SignatureRequestResponse.md) | | | +| `template` | [```\Dropbox\Sign\Model\TemplateResponse```](TemplateResponse.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EventCallbackRequestEvent.md b/sdks/php/docs/Model/EventCallbackRequestEvent.md index e932e37b3..84a3f872f 100644 --- a/sdks/php/docs/Model/EventCallbackRequestEvent.md +++ b/sdks/php/docs/Model/EventCallbackRequestEvent.md @@ -6,9 +6,9 @@ Basic information about the event that occurred. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `event_time`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time the event was created (using Unix time). REPLACE_ME_WITH_DESCRIPTION_END | | -| `event_type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Type of callback event that was triggered. REPLACE_ME_WITH_DESCRIPTION_END | | -| `event_hash`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Generated hash used to verify source of event data. REPLACE_ME_WITH_DESCRIPTION_END | | -| `event_metadata` | [```\Dropbox\Sign\Model\EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `event_time`*_required_ | ```string``` | Time the event was created (using Unix time). | | +| `event_type`*_required_ | ```string``` | Type of callback event that was triggered. | | +| `event_hash`*_required_ | ```string``` | Generated hash used to verify source of event data. | | +| `event_metadata` | [```\Dropbox\Sign\Model\EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md b/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md index 89ce5a7f2..1b7e08e01 100644 --- a/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md +++ b/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md @@ -6,9 +6,9 @@ Specific metadata about the event. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `related_signature_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. REPLACE_ME_WITH_DESCRIPTION_END | | -| `reported_for_account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Account ID the event was reported for. REPLACE_ME_WITH_DESCRIPTION_END | | -| `reported_for_app_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN App ID the event was reported for. REPLACE_ME_WITH_DESCRIPTION_END | | -| `event_message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Message about a declined or failed (due to error) signature flow. REPLACE_ME_WITH_DESCRIPTION_END | | +| `related_signature_id` | ```string``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | | +| `reported_for_account_id` | ```string``` | Account ID the event was reported for. | | +| `reported_for_app_id` | ```string``` | App ID the event was reported for. | | +| `event_message` | ```string``` | Message about a declined or failed (due to error) signature flow. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxGetResponse.md b/sdks/php/docs/Model/FaxGetResponse.md index 8a879bc65..59bea7dc3 100644 --- a/sdks/php/docs/Model/FaxGetResponse.md +++ b/sdks/php/docs/Model/FaxGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax`*_required_ | [```\Dropbox\Sign\Model\FaxResponse```](FaxResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `fax`*_required_ | [```\Dropbox\Sign\Model\FaxResponse```](FaxResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineAddUserRequest.md b/sdks/php/docs/Model/FaxLineAddUserRequest.md index aa10aafff..966ac619f 100644 --- a/sdks/php/docs/Model/FaxLineAddUserRequest.md +++ b/sdks/php/docs/Model/FaxLineAddUserRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The Fax Line number REPLACE_ME_WITH_DESCRIPTION_END | | -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Account ID REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address REPLACE_ME_WITH_DESCRIPTION_END | | +| `number`*_required_ | ```string``` | The Fax Line number | | +| `account_id` | ```string``` | Account ID | | +| `email_address` | ```string``` | Email address | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineAreaCodeGetResponse.md b/sdks/php/docs/Model/FaxLineAreaCodeGetResponse.md index 96835f328..3f1d9039a 100644 --- a/sdks/php/docs/Model/FaxLineAreaCodeGetResponse.md +++ b/sdks/php/docs/Model/FaxLineAreaCodeGetResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `area_codes`*_required_ | ```int[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `area_codes`*_required_ | ```int[]``` | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineCreateRequest.md b/sdks/php/docs/Model/FaxLineCreateRequest.md index a96a60757..3483d66d8 100644 --- a/sdks/php/docs/Model/FaxLineCreateRequest.md +++ b/sdks/php/docs/Model/FaxLineCreateRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `area_code`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Area code of the new Fax Line REPLACE_ME_WITH_DESCRIPTION_END | | -| `country`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Country of the area code REPLACE_ME_WITH_DESCRIPTION_END | | -| `city` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN City of the area code REPLACE_ME_WITH_DESCRIPTION_END | | -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Account ID of the account that will be assigned this new Fax Line REPLACE_ME_WITH_DESCRIPTION_END | | +| `area_code`*_required_ | ```int``` | Area code of the new Fax Line | | +| `country`*_required_ | ```string``` | Country of the area code | | +| `city` | ```string``` | City of the area code | | +| `account_id` | ```string``` | Account ID of the account that will be assigned this new Fax Line | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineDeleteRequest.md b/sdks/php/docs/Model/FaxLineDeleteRequest.md index 212822459..fed4ee118 100644 --- a/sdks/php/docs/Model/FaxLineDeleteRequest.md +++ b/sdks/php/docs/Model/FaxLineDeleteRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The Fax Line number REPLACE_ME_WITH_DESCRIPTION_END | | +| `number`*_required_ | ```string``` | The Fax Line number | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineListResponse.md b/sdks/php/docs/Model/FaxLineListResponse.md index 743397886..3b6398939 100644 --- a/sdks/php/docs/Model/FaxLineListResponse.md +++ b/sdks/php/docs/Model/FaxLineListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `fax_lines`*_required_ | [```\Dropbox\Sign\Model\FaxLineResponseFaxLine[]```](FaxLineResponseFaxLine.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | +| `fax_lines`*_required_ | [```\Dropbox\Sign\Model\FaxLineResponseFaxLine[]```](FaxLineResponseFaxLine.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse```](WarningResponse.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineRemoveUserRequest.md b/sdks/php/docs/Model/FaxLineRemoveUserRequest.md index 7a8611beb..d5b79cefa 100644 --- a/sdks/php/docs/Model/FaxLineRemoveUserRequest.md +++ b/sdks/php/docs/Model/FaxLineRemoveUserRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The Fax Line number REPLACE_ME_WITH_DESCRIPTION_END | | -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Account ID of the user to remove access REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address of the user to remove access REPLACE_ME_WITH_DESCRIPTION_END | | +| `number`*_required_ | ```string``` | The Fax Line number | | +| `account_id` | ```string``` | Account ID of the user to remove access | | +| `email_address` | ```string``` | Email address of the user to remove access | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineResponse.md b/sdks/php/docs/Model/FaxLineResponse.md index 027597275..372b1d043 100644 --- a/sdks/php/docs/Model/FaxLineResponse.md +++ b/sdks/php/docs/Model/FaxLineResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_line`*_required_ | [```\Dropbox\Sign\Model\FaxLineResponseFaxLine```](FaxLineResponseFaxLine.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `fax_line`*_required_ | [```\Dropbox\Sign\Model\FaxLineResponseFaxLine```](FaxLineResponseFaxLine.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse```](WarningResponse.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineResponseFaxLine.md b/sdks/php/docs/Model/FaxLineResponseFaxLine.md index 66ad6e22a..51f479adc 100644 --- a/sdks/php/docs/Model/FaxLineResponseFaxLine.md +++ b/sdks/php/docs/Model/FaxLineResponseFaxLine.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number REPLACE_ME_WITH_DESCRIPTION_END | | -| `created_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Created at REPLACE_ME_WITH_DESCRIPTION_END | | -| `updated_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Updated at REPLACE_ME_WITH_DESCRIPTION_END | | -| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `number` | ```string``` | Number | | +| `created_at` | ```int``` | Created at | | +| `updated_at` | ```int``` | Updated at | | +| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxListResponse.md b/sdks/php/docs/Model/FaxListResponse.md index edd7193e9..5ccdafc91 100644 --- a/sdks/php/docs/Model/FaxListResponse.md +++ b/sdks/php/docs/Model/FaxListResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `faxes`*_required_ | [```\Dropbox\Sign\Model\FaxResponse[]```](FaxResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `faxes`*_required_ | [```\Dropbox\Sign\Model\FaxResponse[]```](FaxResponse.md) | | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxResponse.md b/sdks/php/docs/Model/FaxResponse.md index 52651d68f..130845b57 100644 --- a/sdks/php/docs/Model/FaxResponse.md +++ b/sdks/php/docs/Model/FaxResponse.md @@ -6,16 +6,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax ID REPLACE_ME_WITH_DESCRIPTION_END | | -| `title`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Title REPLACE_ME_WITH_DESCRIPTION_END | | -| `original_title`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Original Title REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata`*_required_ | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Metadata REPLACE_ME_WITH_DESCRIPTION_END | | -| `created_at`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Created At Timestamp REPLACE_ME_WITH_DESCRIPTION_END | | -| `sender`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Sender Email REPLACE_ME_WITH_DESCRIPTION_END | | -| `files_url`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Files URL REPLACE_ME_WITH_DESCRIPTION_END | | -| `transmissions`*_required_ | [```\Dropbox\Sign\Model\FaxResponseTransmission[]```](FaxResponseTransmission.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Transmissions List REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Subject REPLACE_ME_WITH_DESCRIPTION_END | | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Message REPLACE_ME_WITH_DESCRIPTION_END | | -| `final_copy_uri` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The path where the completed document can be downloaded REPLACE_ME_WITH_DESCRIPTION_END | | +| `fax_id`*_required_ | ```string``` | Fax ID | | +| `title`*_required_ | ```string``` | Fax Title | | +| `original_title`*_required_ | ```string``` | Fax Original Title | | +| `metadata`*_required_ | ```array``` | Fax Metadata | | +| `created_at`*_required_ | ```int``` | Fax Created At Timestamp | | +| `sender`*_required_ | ```string``` | Fax Sender Email | | +| `files_url`*_required_ | ```string``` | Fax Files URL | | +| `transmissions`*_required_ | [```\Dropbox\Sign\Model\FaxResponseTransmission[]```](FaxResponseTransmission.md) | Fax Transmissions List | | +| `subject` | ```string``` | Fax Subject | | +| `message` | ```string``` | Fax Message | | +| `final_copy_uri` | ```string``` | The path where the completed document can be downloaded | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxResponseTransmission.md b/sdks/php/docs/Model/FaxResponseTransmission.md index 0c3ce0498..353e745f0 100644 --- a/sdks/php/docs/Model/FaxResponseTransmission.md +++ b/sdks/php/docs/Model/FaxResponseTransmission.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Transmission Recipient REPLACE_ME_WITH_DESCRIPTION_END | | -| `status_code`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Transmission Status Code REPLACE_ME_WITH_DESCRIPTION_END | | -| `sent_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Transmission Sent Timestamp REPLACE_ME_WITH_DESCRIPTION_END | | +| `recipient`*_required_ | ```string``` | Fax Transmission Recipient | | +| `status_code`*_required_ | ```string``` | Fax Transmission Status Code | | +| `sent_at` | ```int``` | Fax Transmission Sent Timestamp | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxSendRequest.md b/sdks/php/docs/Model/FaxSendRequest.md index 238bb8eb6..432fd5ef6 100644 --- a/sdks/php/docs/Model/FaxSendRequest.md +++ b/sdks/php/docs/Model/FaxSendRequest.md @@ -6,19 +6,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Recipient of the fax -Can be a phone number in E.164 format or email address REPLACE_ME_WITH_DESCRIPTION_END | | -| `sender` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Send From Sender (used only with fax number) REPLACE_ME_WITH_DESCRIPTION_END | | -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to fax - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Fax download the file(s) to fax - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN API Test Mode Setting REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `cover_page_to` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax cover page recipient information REPLACE_ME_WITH_DESCRIPTION_END | | -| `cover_page_from` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax cover page sender information REPLACE_ME_WITH_DESCRIPTION_END | | -| `cover_page_message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Cover Page Message REPLACE_ME_WITH_DESCRIPTION_END | | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Fax Title REPLACE_ME_WITH_DESCRIPTION_END | | +| `recipient`*_required_ | ```string``` | Recipient of the fax Can be a phone number in E.164 format or email address | | +| `sender` | ```string``` | Fax Send From Sender (used only with fax number) | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `test_mode` | ```bool``` | API Test Mode Setting | [default to false] | +| `cover_page_to` | ```string``` | Fax cover page recipient information | | +| `cover_page_from` | ```string``` | Fax cover page sender information | | +| `cover_page_message` | ```string``` | Fax Cover Page Message | | +| `title` | ```string``` | Fax Title | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FileResponse.md b/sdks/php/docs/Model/FileResponse.md index 64d38a591..5803b6565 100644 --- a/sdks/php/docs/Model/FileResponse.md +++ b/sdks/php/docs/Model/FileResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `file_url`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN URL to the file. REPLACE_ME_WITH_DESCRIPTION_END | | -| `expires_at`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the link expires. REPLACE_ME_WITH_DESCRIPTION_END | | +| `file_url`*_required_ | ```string``` | URL to the file. | | +| `expires_at`*_required_ | ```int``` | When the link expires. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FileResponseDataUri.md b/sdks/php/docs/Model/FileResponseDataUri.md index fb55e4623..dbead09b0 100644 --- a/sdks/php/docs/Model/FileResponseDataUri.md +++ b/sdks/php/docs/Model/FileResponseDataUri.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `data_uri`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN File as base64 encoded string. REPLACE_ME_WITH_DESCRIPTION_END | | +| `data_uri`*_required_ | ```string``` | File as base64 encoded string. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ListInfoResponse.md b/sdks/php/docs/Model/ListInfoResponse.md index e5a8642c4..872ace684 100644 --- a/sdks/php/docs/Model/ListInfoResponse.md +++ b/sdks/php/docs/Model/ListInfoResponse.md @@ -6,9 +6,9 @@ Contains pagination information about the data returned. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_pages` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Total number of pages available. REPLACE_ME_WITH_DESCRIPTION_END | | -| `num_results` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Total number of objects available. REPLACE_ME_WITH_DESCRIPTION_END | | -| `page` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of the page being returned. REPLACE_ME_WITH_DESCRIPTION_END | | -| `page_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Objects returned per page. REPLACE_ME_WITH_DESCRIPTION_END | | +| `num_pages` | ```int``` | Total number of pages available. | | +| `num_results` | ```int``` | Total number of objects available. | | +| `page` | ```int``` | Number of the page being returned. | | +| `page_size` | ```int``` | Objects returned per page. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/OAuthTokenGenerateRequest.md b/sdks/php/docs/Model/OAuthTokenGenerateRequest.md index 81c08c51d..40eaf49f9 100644 --- a/sdks/php/docs/Model/OAuthTokenGenerateRequest.md +++ b/sdks/php/docs/Model/OAuthTokenGenerateRequest.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The client id of the app requesting authorization. REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_secret`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The secret token of your app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `code`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The code passed to your callback when the user granted access. REPLACE_ME_WITH_DESCRIPTION_END | | -| `grant_type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When generating a new token use `authorization_code`. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'authorization_code'] | -| `state`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Same as the state you specified earlier. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id`*_required_ | ```string``` | The client id of the app requesting authorization. | | +| `client_secret`*_required_ | ```string``` | The secret token of your app. | | +| `code`*_required_ | ```string``` | The code passed to your callback when the user granted access. | | +| `grant_type`*_required_ | ```string``` | When generating a new token use `authorization_code`. | [default to 'authorization_code'] | +| `state`*_required_ | ```string``` | Same as the state you specified earlier. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/OAuthTokenRefreshRequest.md b/sdks/php/docs/Model/OAuthTokenRefreshRequest.md index 28728cbc9..9ba09db42 100644 --- a/sdks/php/docs/Model/OAuthTokenRefreshRequest.md +++ b/sdks/php/docs/Model/OAuthTokenRefreshRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `grant_type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When refreshing an existing token use `refresh_token`. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'refresh_token'] | -| `refresh_token`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The token provided when you got the expired access token. REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_secret` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. REPLACE_ME_WITH_DESCRIPTION_END | | +| `grant_type`*_required_ | ```string``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | +| `refresh_token`*_required_ | ```string``` | The token provided when you got the expired access token. | | +| `client_id` | ```string``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `client_secret` | ```string``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/OAuthTokenResponse.md b/sdks/php/docs/Model/OAuthTokenResponse.md index 0046f9dc3..016f00e9b 100644 --- a/sdks/php/docs/Model/OAuthTokenResponse.md +++ b/sdks/php/docs/Model/OAuthTokenResponse.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `access_token` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `token_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `refresh_token` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `expires_in` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of seconds until the `access_token` expires. Uses epoch time. REPLACE_ME_WITH_DESCRIPTION_END | | -| `state` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `access_token` | ```string``` | | | +| `token_type` | ```string``` | | | +| `refresh_token` | ```string``` | | | +| `expires_in` | ```int``` | Number of seconds until the `access_token` expires. Uses epoch time. | | +| `state` | ```string``` | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ReportCreateRequest.md b/sdks/php/docs/Model/ReportCreateRequest.md index 32ba37859..490958a41 100644 --- a/sdks/php/docs/Model/ReportCreateRequest.md +++ b/sdks/php/docs/Model/ReportCreateRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `end_date`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The (inclusive) end date for the report data in `MM/DD/YYYY` format. REPLACE_ME_WITH_DESCRIPTION_END | | -| `report_type`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). REPLACE_ME_WITH_DESCRIPTION_END | | -| `start_date`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The (inclusive) start date for the report data in `MM/DD/YYYY` format. REPLACE_ME_WITH_DESCRIPTION_END | | +| `end_date`*_required_ | ```string``` | The (inclusive) end date for the report data in `MM/DD/YYYY` format. | | +| `report_type`*_required_ | ```string[]``` | The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). | | +| `start_date`*_required_ | ```string``` | The (inclusive) start date for the report data in `MM/DD/YYYY` format. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ReportCreateResponse.md b/sdks/php/docs/Model/ReportCreateResponse.md index 076c496bb..335d94a47 100644 --- a/sdks/php/docs/Model/ReportCreateResponse.md +++ b/sdks/php/docs/Model/ReportCreateResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `report`*_required_ | [```\Dropbox\Sign\Model\ReportResponse```](ReportResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `report`*_required_ | [```\Dropbox\Sign\Model\ReportResponse```](ReportResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ReportResponse.md b/sdks/php/docs/Model/ReportResponse.md index 8a4cc13cb..3b253ce4e 100644 --- a/sdks/php/docs/Model/ReportResponse.md +++ b/sdks/php/docs/Model/ReportResponse.md @@ -6,9 +6,9 @@ Contains information about the report request. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `success` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A message indicating the requested operation's success REPLACE_ME_WITH_DESCRIPTION_END | | -| `start_date` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The (inclusive) start date for the report data in MM/DD/YYYY format. REPLACE_ME_WITH_DESCRIPTION_END | | -| `end_date` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The (inclusive) end date for the report data in MM/DD/YYYY format. REPLACE_ME_WITH_DESCRIPTION_END | | -| `report_type` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type(s) of the report you are requesting. Allowed values are "user_activity" and "document_status". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). REPLACE_ME_WITH_DESCRIPTION_END | | +| `success` | ```string``` | A message indicating the requested operation's success | | +| `start_date` | ```string``` | The (inclusive) start date for the report data in MM/DD/YYYY format. | | +| `end_date` | ```string``` | The (inclusive) end date for the report data in MM/DD/YYYY format. | | +| `report_type` | ```string[]``` | The type(s) of the report you are requesting. Allowed values are "user_activity" and "document_status". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index 0f9cc799d..53be15f83 100644 --- a/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -6,44 +6,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_ids`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to create this embedded signature request. Used for security purposes. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_file` | ```\SplFileObject``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - -- `name`: the name of the signer filling the role of RoleName -- `email_address`: email address of the signer filling the role of RoleName -- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) -- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) - - By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - - **NOTE:** Not available in test mode and requires a Standard plan or higher. -- `*_field`: any column with a _field" suffix will be treated as a custom field (optional) - - You may only specify field values here, any other options should be set in the custom_fields request parameter. - -Example CSV: - -``` -name, email_address, pin, company_field -George, george@example.com, d79a3td, ABC Corp -Mary, mary@example.com, gd9as5b, 123 LLC -``` REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_list` | [```\Dropbox\Sign\Model\SubBulkSignerList[]```](SubBulkSignerList.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add CC email recipients. Required when a CC role exists for the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. - -Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. - -For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signer_file` | ```\SplFileObject``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:

- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | | +| `signer_list` | [```\Dropbox\Sign\Model\SubBulkSignerList[]```](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md index 939031e2a..10d93b867 100644 --- a/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md @@ -6,44 +6,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_ids`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_file` | ```\SplFileObject``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - -- `name`: the name of the signer filling the role of RoleName -- `email_address`: email address of the signer filling the role of RoleName -- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) -- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) - - By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - - **NOTE:** Not available in test mode and requires a Standard plan or higher. -- `*_field`: any column with a _field" suffix will be treated as a custom field (optional) - - You may only specify field values here, any other options should be set in the custom_fields request parameter. - -Example CSV: - -``` -name, email_address, pin, company_field -George, george@example.com, d79a3td, ABC Corp -Mary, mary@example.com, gd9as5b, 123 LLC -``` REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_list` | [```\Dropbox\Sign\Model\SubBulkSignerList[]```](SubBulkSignerList.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add CC email recipients. Required when a CC role exists for the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. - -Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. - -For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signer_file` | ```\SplFileObject``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:

- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | | +| `signer_list` | [```\Dropbox\Sign\Model\SubBulkSignerList[]```](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `client_id` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md index 9b55e281e..a953bcbc2 100644 --- a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md @@ -6,62 +6,29 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to create this embedded signature request. Used for security purposes. REPLACE_ME_WITH_DESCRIPTION_END | | -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Signature Request. - -This endpoint requires either **signers** or **grouped_signers**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Grouped Signers to your Signature Request. - -This endpoint requires either **signers** or **grouped_signers**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. - -**NOTE:** Only available for Premium plan. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | -| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email addresses that should be CCed. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. - -Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. - -For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) - -**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. - -* Text Field use `SubFormFieldsPerDocumentText` -* Dropdown Field use `SubFormFieldsPerDocumentDropdown` -* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` -* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` -* Radio Field use `SubFormFieldsPerDocumentRadio` -* Signature Field use `SubFormFieldsPerDocumentSignature` -* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` -* Initials Field use `SubFormFieldsPerDocumentInitials` -* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` -* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | -| `hide_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Enables automatic Text Tag removal when set to true. - -**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `use_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `populate_auto_fill_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. - -**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 385dae2b1..b41a8e311 100644 --- a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -6,28 +6,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_ids`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to create this embedded signature request. Used for security purposes. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Templated-based Signature Request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add CC email recipients. Required when a CC role exists for the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array defining values and options for custom fields. Required when a custom field exists in the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `populate_auto_fill_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. - -**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestGetResponse.md b/sdks/php/docs/Model/SignatureRequestGetResponse.md index e3eb44ee0..c2f3c97b7 100644 --- a/sdks/php/docs/Model/SignatureRequestGetResponse.md +++ b/sdks/php/docs/Model/SignatureRequestGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_request`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse```](SignatureRequestResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signature_request`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse```](SignatureRequestResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestListResponse.md b/sdks/php/docs/Model/SignatureRequestListResponse.md index 7f1614f15..c0aae36cd 100644 --- a/sdks/php/docs/Model/SignatureRequestListResponse.md +++ b/sdks/php/docs/Model/SignatureRequestListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse[]```](SignatureRequestResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains information about signature requests. REPLACE_ME_WITH_DESCRIPTION_END | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse[]```](SignatureRequestResponse.md) | Contains information about signature requests. | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestRemindRequest.md b/sdks/php/docs/Model/SignatureRequestRemindRequest.md index 5fa71821c..e8b9292f8 100644 --- a/sdks/php/docs/Model/SignatureRequestRemindRequest.md +++ b/sdks/php/docs/Model/SignatureRequestRemindRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer to send a reminder to. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer to send a reminder to. Include if two or more signers share an email address. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address`*_required_ | ```string``` | The email address of the signer to send a reminder to. | | +| `name` | ```string``` | The name of the signer to send a reminder to. Include if two or more signers share an email address. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponse.md b/sdks/php/docs/Model/SignatureRequestResponse.md index 63d2f4351..bb04b5d30 100644 --- a/sdks/php/docs/Model/SignatureRequestResponse.md +++ b/sdks/php/docs/Model/SignatureRequestResponse.md @@ -6,33 +6,30 @@ Contains information about a signature request. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `signature_request_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `requester_email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the initiator of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title the specified Account uses for the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `original_title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Default Label for account. REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that was initially sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that was initially sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The metadata attached to the signature request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `created_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time the signature request was created. REPLACE_ME_WITH_DESCRIPTION_END | | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_complete` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not the SignatureRequest has been fully executed by all signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_declined` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not the SignatureRequest has been declined by a signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `has_error` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). REPLACE_ME_WITH_DESCRIPTION_END | | -| `files_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where a copy of the request's documents can be downloaded. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. REPLACE_ME_WITH_DESCRIPTION_END | | -| `details_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL where the requester and the signers can view the current status of the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want the signer redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `final_copy_uri` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The path where the completed document can be downloaded REPLACE_ME_WITH_DESCRIPTION_END | | -| `template_ids` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Templates IDs used in this SignatureRequest (if any). REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of Custom Field objects containing the name and type of each custom field. - -* Text Field uses `SignatureRequestResponseCustomFieldText` -* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` REPLACE_ME_WITH_DESCRIPTION_END | | -| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signer attachments. REPLACE_ME_WITH_DESCRIPTION_END | | -| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of signature objects, 1 for each signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `bulk_send_job_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The ID of the Bulk Send job which sent the signature request, if applicable. REPLACE_ME_WITH_DESCRIPTION_END | | +| `test_mode` | ```bool``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to false] | +| `signature_request_id` | ```string``` | The id of the SignatureRequest. | | +| `requester_email_address` | ```string``` | The email address of the initiator of the SignatureRequest. | | +| `title` | ```string``` | The title the specified Account uses for the SignatureRequest. | | +| `original_title` | ```string``` | Default Label for account. | | +| `subject` | ```string``` | The subject in the email that was initially sent to the signers. | | +| `message` | ```string``` | The custom message in the email that was initially sent to the signers. | | +| `metadata` | ```array``` | The metadata attached to the signature request. | | +| `created_at` | ```int``` | Time the signature request was created. | | +| `expires_at` | ```int``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `is_complete` | ```bool``` | Whether or not the SignatureRequest has been fully executed by all signers. | | +| `is_declined` | ```bool``` | Whether or not the SignatureRequest has been declined by a signer. | | +| `has_error` | ```bool``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | +| `files_url` | ```string``` | The URL where a copy of the request's documents can be downloaded. | | +| `signing_url` | ```string``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | +| `details_url` | ```string``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | +| `cc_email_addresses` | ```string[]``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | +| `signing_redirect_url` | ```string``` | The URL you want the signer redirected to after they successfully sign. | | +| `final_copy_uri` | ```string``` | The path where the completed document can be downloaded | | +| `template_ids` | ```string[]``` | Templates IDs used in this SignatureRequest (if any). | | +| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | +| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | +| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | +| `bulk_send_job_id` | ```string``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseAttachment.md b/sdks/php/docs/Model/SignatureRequestResponseAttachment.md index 601358432..6e84393ae 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseAttachment.md +++ b/sdks/php/docs/Model/SignatureRequestResponseAttachment.md @@ -6,11 +6,11 @@ Signer attachments. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The unique ID for this attachment. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The Signer this attachment is assigned to. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of this attachment. REPLACE_ME_WITH_DESCRIPTION_END | | -| `required`*_required_ | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A boolean value denoting if this attachment is required. REPLACE_ME_WITH_DESCRIPTION_END | | -| `instructions` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Instructions for Signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `uploaded_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Timestamp when attachment was uploaded by Signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `id`*_required_ | ```string``` | The unique ID for this attachment. | | +| `signer`*_required_ | ```string``` | The Signer this attachment is assigned to. | | +| `name`*_required_ | ```string``` | The name of this attachment. | | +| `required`*_required_ | ```bool``` | A boolean value denoting if this attachment is required. | | +| `instructions` | ```string``` | Instructions for Signer. | | +| `uploaded_at` | ```int``` | Timestamp when attachment was uploaded by Signer. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md index 88017781c..40685da58 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md +++ b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md @@ -2,17 +2,17 @@ An array of Custom Field objects containing the name and type of each custom field. -* Text Field uses `SignatureRequestResponseCustomFieldText` -* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` +* Text Field uses `SignatureRequestResponseCustomFieldText` +* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the Custom Field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A boolean value denoting if this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | -| `api_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The unique ID for this field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `editor` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the Role that is able to edit this field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | +| `name`*_required_ | ```string``` | The name of the Custom Field. | | +| `required` | ```bool``` | A boolean value denoting if this field is required. | | +| `api_id` | ```string``` | The unique ID for this field. | | +| `editor` | ```string``` | The name of the Role that is able to edit this field. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md index 695550b8e..08c64f658 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md +++ b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md @@ -1,12 +1,12 @@ # # SignatureRequestResponseCustomFieldCheckbox -This class extends `SignatureRequestResponseCustomFieldBase`. +This class extends `SignatureRequestResponseCustomFieldBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | -| `value` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A true/false for checkbox fields REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'checkbox'] | +| `value` | ```bool``` | A true/false for checkbox fields | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md index a73ed1b8f..38486e804 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md +++ b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md @@ -1,12 +1,12 @@ # # SignatureRequestResponseCustomFieldText -This class extends `SignatureRequestResponseCustomFieldBase`. +This class extends `SignatureRequestResponseCustomFieldBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | -| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A text string for text fields REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'text'] | +| `value` | ```string``` | A text string for text fields | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataBase.md b/sdks/php/docs/Model/SignatureRequestResponseDataBase.md index f4752ef79..7a1f3ef03 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataBase.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataBase.md @@ -6,10 +6,10 @@ An array of form field objects containing the name, value, and type of each text Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The unique ID for this field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signature_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The ID of the signature to which this response is linked. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A boolean value denoting if this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `api_id` | ```string``` | The unique ID for this field. | | +| `signature_id` | ```string``` | The ID of the signature to which this response is linked. | | +| `name` | ```string``` | The name of the form field. | | +| `required` | ```bool``` | A boolean value denoting if this field is required. | | +| `type` | ```string``` | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md index aa6bdd92c..dfdc66f06 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A yes/no checkbox REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | -| `value` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type` | ```string``` | A yes/no checkbox | [default to 'checkbox'] | +| `value` | ```bool``` | The value of the form field. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md index 153d2003f..00475b7bd 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A checkbox field that has default value set by the api REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox-merge'] | -| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type` | ```string``` | A checkbox field that has default value set by the api | [default to 'checkbox-merge'] | +| `value` | ```string``` | The value of the form field. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md index f8e063b7a..56a613c94 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A date REPLACE_ME_WITH_DESCRIPTION_END | [default to 'date_signed'] | -| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type` | ```string``` | A date | [default to 'date_signed'] | +| `value` | ```string``` | The value of the form field. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md index fd962c060..61ddaae67 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for dropdowns REPLACE_ME_WITH_DESCRIPTION_END | [default to 'dropdown'] | -| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type` | ```string``` | An input field for dropdowns | [default to 'dropdown'] | +| `value` | ```string``` | The value of the form field. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md index 9b74912fe..f4bf660f6 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for initials REPLACE_ME_WITH_DESCRIPTION_END | [default to 'initials'] | -| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_signed` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This field contains the boolean true if the field is signed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type` | ```string``` | An input field for initials | [default to 'initials'] | +| `value` | ```string``` | The value of the form field. | | +| `is_signed` | ```bool``` | This field contains the boolean true if the field is signed. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md index 7c53889da..e5de3e9af 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for radios REPLACE_ME_WITH_DESCRIPTION_END | [default to 'radio'] | -| `value` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type` | ```string``` | An input field for radios | [default to 'radio'] | +| `value` | ```bool``` | The value of the form field. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md index 321cd3918..877febbcd 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A signature input field REPLACE_ME_WITH_DESCRIPTION_END | [default to 'signature'] | -| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_signed` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This field contains the boolean true if the field is signed. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type` | ```string``` | A signature input field | [default to 'signature'] | +| `value` | ```string``` | The value of the form field. | | +| `is_signed` | ```bool``` | This field contains the boolean true if the field is signed. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md index 0c1c88a04..6058f2017 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A text input field REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | -| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type` | ```string``` | A text input field | [default to 'text'] | +| `value` | ```string``` | The value of the form field. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md index 962e7146b..e1b140727 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A text field that has default text set by the api REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text-merge'] | -| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type` | ```string``` | A text field that has default text set by the api | [default to 'text-merge'] | +| `value` | ```string``` | The value of the form field. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseSignatures.md b/sdks/php/docs/Model/SignatureRequestResponseSignatures.md index 2de63767b..6d49a3089 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseSignatures.md +++ b/sdks/php/docs/Model/SignatureRequestResponseSignatures.md @@ -6,24 +6,24 @@ An array of signature objects, 1 for each signer. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signature identifier. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_group_guid` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signer Group GUID REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_role` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The role of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN If signer order is assigned this is the 0-based index for this signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `status_code` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The current status of the signature. eg: awaiting_signature, signed, declined. REPLACE_ME_WITH_DESCRIPTION_END | | -| `decline_reason` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The reason provided by the signer for declining the request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signed_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time that the document was signed or null. REPLACE_ME_WITH_DESCRIPTION_END | | -| `last_viewed_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The time that the document was last viewed by this signer or null. REPLACE_ME_WITH_DESCRIPTION_END | | -| `last_reminded_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The time the last reminder email was sent to the signer or null. REPLACE_ME_WITH_DESCRIPTION_END | | -| `has_pin` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean to indicate whether this signature requires a PIN to access. REPLACE_ME_WITH_DESCRIPTION_END | | -| `has_sms_auth` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean to indicate whether this signature has SMS authentication enabled. REPLACE_ME_WITH_DESCRIPTION_END | | -| `has_sms_delivery` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean to indicate whether this signature has SMS delivery enabled. REPLACE_ME_WITH_DESCRIPTION_END | | -| `sms_phone_number` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The SMS phone number used for authentication or signature request delivery. REPLACE_ME_WITH_DESCRIPTION_END | | -| `reassigned_by` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address of original signer who reassigned to this signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `reassignment_reason` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Reason provided by original signer who reassigned to this signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `reassigned_from` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Previous signature identifier. REPLACE_ME_WITH_DESCRIPTION_END | | -| `error` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Error message pertaining to this signer, or null. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signature_id` | ```string``` | Signature identifier. | | +| `signer_group_guid` | ```string``` | Signer Group GUID | | +| `signer_email_address` | ```string``` | The email address of the signer. | | +| `signer_name` | ```string``` | The name of the signer. | | +| `signer_role` | ```string``` | The role of the signer. | | +| `order` | ```int``` | If signer order is assigned this is the 0-based index for this signer. | | +| `status_code` | ```string``` | The current status of the signature. eg: awaiting_signature, signed, declined. | | +| `decline_reason` | ```string``` | The reason provided by the signer for declining the request. | | +| `signed_at` | ```int``` | Time that the document was signed or null. | | +| `last_viewed_at` | ```int``` | The time that the document was last viewed by this signer or null. | | +| `last_reminded_at` | ```int``` | The time the last reminder email was sent to the signer or null. | | +| `has_pin` | ```bool``` | Boolean to indicate whether this signature requires a PIN to access. | | +| `has_sms_auth` | ```bool``` | Boolean to indicate whether this signature has SMS authentication enabled. | | +| `has_sms_delivery` | ```bool``` | Boolean to indicate whether this signature has SMS delivery enabled. | | +| `sms_phone_number` | ```string``` | The SMS phone number used for authentication or signature request delivery. | | +| `reassigned_by` | ```string``` | Email address of original signer who reassigned to this signer. | | +| `reassignment_reason` | ```string``` | Reason provided by original signer who reassigned to this signer. | | +| `reassigned_from` | ```string``` | Previous signature identifier. | | +| `error` | ```string``` | Error message pertaining to this signer, or null. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestSendRequest.md b/sdks/php/docs/Model/SignatureRequestSendRequest.md index bbd64c005..65d3a7d91 100644 --- a/sdks/php/docs/Model/SignatureRequestSendRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendRequest.md @@ -6,69 +6,31 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Signature Request. - -This endpoint requires either **signers** or **grouped_signers**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Grouped Signers to your Signature Request. - -This endpoint requires either **signers** or **grouped_signers**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. - -**NOTE:** Only available for Premium plan and higher. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | -| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email addresses that should be CCed. REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. - -Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. - -For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) - -**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. - -* Text Field use `SubFormFieldsPerDocumentText` -* Dropdown Field use `SubFormFieldsPerDocumentDropdown` -* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` -* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` -* Radio Field use `SubFormFieldsPerDocumentRadio` -* Signature Field use `SubFormFieldsPerDocumentSignature` -* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` -* Initials Field use `SubFormFieldsPerDocumentInitials` -* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` -* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | -| `hide_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Enables automatic Text Tag removal when set to true. - -**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `is_qualified_signature` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable -[Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), -which requires a face-to-face call to verify the signer's identity.<br> -**NOTE:** QES is only available on the Premium API plan as an add-on purchase. -Cannot be used in `test_mode`. Only works on requests with one signer. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `is_eid` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable -[electronic identification (eID)](https://www.hellosign.com/features/electronic-id), -which requires the signer to verify their identity with an eID provider to sign a document.<br> -**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `use_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. REPLACE_ME_WITH_DESCRIPTION_END | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | +| `client_id` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | +| `is_qualified_signature` | ```bool``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md index e7de13434..cbfaeb338 100644 --- a/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md @@ -6,35 +6,22 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_ids`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Templated-based Signature Request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add CC email recipients. Required when a CC role exists for the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array defining values and options for custom fields. Required when a custom field exists in the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_qualified_signature` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable -[Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), -which requires a face-to-face call to verify the signer's identity.<br> -**NOTE:** QES is only available on the Premium API plan as an add-on purchase. -Cannot be used in `test_mode`. Only works on requests with one signer. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `is_eid` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable -[electronic identification (eID)](https://www.hellosign.com/features/electronic-id), -which requires the signer to verify their identity with an eID provider to sign a document.<br> -**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `client_id` | ```string``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `is_qualified_signature` | ```bool``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestUpdateRequest.md b/sdks/php/docs/Model/SignatureRequestUpdateRequest.md index 2e91cfac8..abccc2572 100644 --- a/sdks/php/docs/Model/SignatureRequestUpdateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestUpdateRequest.md @@ -6,15 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The signature ID for the recipient. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The new email address for the recipient. - -This will generate a new `signature_id` value. - -**NOTE:** Optional if `name` is provided. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The new name for the recipient. - -**NOTE:** Optional if `email_address` is provided. REPLACE_ME_WITH_DESCRIPTION_END | | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signature_id`*_required_ | ```string``` | The signature ID for the recipient. | | +| `email_address` | ```string``` | The new email address for the recipient.

This will generate a new `signature_id` value.

**NOTE:** Optional if `name` is provided. | | +| `name` | ```string``` | The new name for the recipient.

**NOTE:** Optional if `email_address` is provided. | | +| `expires_at` | ```int``` | The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubAttachment.md b/sdks/php/docs/Model/SubAttachment.md index b61101dab..3f87942f8 100644 --- a/sdks/php/docs/Model/SubAttachment.md +++ b/sdks/php/docs/Model/SubAttachment.md @@ -6,11 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of attachment. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_index`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The signer's index in the `signers` parameter (0-based indexing). - -**NOTE:** Only one signer can be assigned per attachment. REPLACE_ME_WITH_DESCRIPTION_END | | -| `instructions` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The instructions for uploading the attachment. REPLACE_ME_WITH_DESCRIPTION_END | | -| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Determines if the attachment must be uploaded. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `name`*_required_ | ```string``` | The name of attachment. | | +| `signer_index`*_required_ | ```int``` | The signer's index in the `signers` parameter (0-based indexing).

**NOTE:** Only one signer can be assigned per attachment. | | +| `instructions` | ```string``` | The instructions for uploading the attachment. | | +| `required` | ```bool``` | Determines if the attachment must be uploaded. | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubBulkSignerList.md b/sdks/php/docs/Model/SubBulkSignerList.md index 63c577a16..9842742e5 100644 --- a/sdks/php/docs/Model/SubBulkSignerList.md +++ b/sdks/php/docs/Model/SubBulkSignerList.md @@ -6,9 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `custom_fields` | [```\Dropbox\Sign\Model\SubBulkSignerListCustomField[]```](SubBulkSignerListCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of custom field values. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. - -Currently only templates with a single role are supported. All signers must have the same `role` value. REPLACE_ME_WITH_DESCRIPTION_END | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubBulkSignerListCustomField[]```](SubBulkSignerListCustomField.md) | An array of custom field values. | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.

Currently only templates with a single role are supported. All signers must have the same `role` value. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubBulkSignerListCustomField.md b/sdks/php/docs/Model/SubBulkSignerListCustomField.md index 5f2b59500..0eca191cb 100644 --- a/sdks/php/docs/Model/SubBulkSignerListCustomField.md +++ b/sdks/php/docs/Model/SubBulkSignerListCustomField.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the custom field. Must be the field's `name` or `api_id`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `value`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The value of the custom field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name`*_required_ | ```string``` | The name of the custom field. Must be the field's `name` or `api_id`. | | +| `value`*_required_ | ```string``` | The value of the custom field. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubCC.md b/sdks/php/docs/Model/SubCC.md index ff3ff75db..2f77e26db 100644 --- a/sdks/php/docs/Model/SubCC.md +++ b/sdks/php/docs/Model/SubCC.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the CC recipient. REPLACE_ME_WITH_DESCRIPTION_END | | +| `role`*_required_ | ```string``` | Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role. | | +| `email_address`*_required_ | ```string``` | The email address of the CC recipient. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubCustomField.md b/sdks/php/docs/Model/SubCustomField.md index 6d6a62803..ff1b713d7 100644 --- a/sdks/php/docs/Model/SubCustomField.md +++ b/sdks/php/docs/Model/SubCustomField.md @@ -1,20 +1,18 @@ # # SubCustomField -When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. +When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. -Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. +Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. -For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. +For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing. REPLACE_ME_WITH_DESCRIPTION_END | | -| `editor` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. - -**NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. REPLACE_ME_WITH_DESCRIPTION_END | | -| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name`*_required_ | ```string``` | The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing. | | +| `editor` | ```string``` | Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.

**NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. | | +| `required` | ```bool``` | Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`. | [default to false] | +| `value` | ```string``` | The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubEditorOptions.md b/sdks/php/docs/Model/SubEditorOptions.md index 023c069a3..2cffacfa1 100644 --- a/sdks/php/docs/Model/SubEditorOptions.md +++ b/sdks/php/docs/Model/SubEditorOptions.md @@ -6,7 +6,7 @@ This allows the requester to specify editor options when a preparing a document Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `allow_edit_signers` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows requesters to edit the list of signers REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `allow_edit_documents` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows requesters to edit documents, including delete and add REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `allow_edit_signers` | ```bool``` | Allows requesters to edit the list of signers | [default to false] | +| `allow_edit_documents` | ```bool``` | Allows requesters to edit documents, including delete and add | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFieldOptions.md b/sdks/php/docs/Model/SubFieldOptions.md index 2e458fb2e..f8f275ebe 100644 --- a/sdks/php/docs/Model/SubFieldOptions.md +++ b/sdks/php/docs/Model/SubFieldOptions.md @@ -6,8 +6,6 @@ This allows the requester to specify field options for a signature request. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `date_format`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) - -**NOTE:** Only available for Premium and higher. REPLACE_ME_WITH_DESCRIPTION_END | | +| `date_format`*_required_ | ```string``` | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))

**NOTE:** Only available for Premium and higher. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldGroup.md b/sdks/php/docs/Model/SubFormFieldGroup.md index 5bba51dc4..006da0dc1 100644 --- a/sdks/php/docs/Model/SubFormFieldGroup.md +++ b/sdks/php/docs/Model/SubFormFieldGroup.md @@ -6,12 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `group_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `group_label`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Name of the group REPLACE_ME_WITH_DESCRIPTION_END | | -| `requirement`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Examples: `require_0-1` `require_1` `require_1-ormore` - -- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). -- Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). -- Radio groups require **at least** two fields per group. REPLACE_ME_WITH_DESCRIPTION_END | | +| `group_id`*_required_ | ```string``` | ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`. | | +| `group_label`*_required_ | ```string``` | Name of the group | | +| `requirement`*_required_ | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldRule.md b/sdks/php/docs/Model/SubFormFieldRule.md index f7d49d01a..fca10b343 100644 --- a/sdks/php/docs/Model/SubFormFieldRule.md +++ b/sdks/php/docs/Model/SubFormFieldRule.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Must be unique across all defined rules. REPLACE_ME_WITH_DESCRIPTION_END | | -| `trigger_operator`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Currently only `AND` is supported. Support for `OR` is being worked on. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'AND'] | -| `triggers`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldRuleTrigger[]```](SubFormFieldRuleTrigger.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed. REPLACE_ME_WITH_DESCRIPTION_END | | -| `actions`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldRuleAction[]```](SubFormFieldRuleAction.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule. REPLACE_ME_WITH_DESCRIPTION_END | | +| `id`*_required_ | ```string``` | Must be unique across all defined rules. | | +| `trigger_operator`*_required_ | ```string``` | Currently only `AND` is supported. Support for `OR` is being worked on. | [default to 'AND'] | +| `triggers`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldRuleTrigger[]```](SubFormFieldRuleTrigger.md) | An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed. | | +| `actions`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldRuleAction[]```](SubFormFieldRuleAction.md) | An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldRuleAction.md b/sdks/php/docs/Model/SubFormFieldRuleAction.md index 5b4d8ed0e..0c4b275a6 100644 --- a/sdks/php/docs/Model/SubFormFieldRuleAction.md +++ b/sdks/php/docs/Model/SubFormFieldRuleAction.md @@ -6,17 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `hidden`*_required_ | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `true` to hide the target field when rule is satisfied, otherwise `false`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `field_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **field_id** or **group_id** is required, but not both. - -Must reference the `api_id` of an existing field defined within `form_fields_per_document`. - -Cannot use with `group_id`. Trigger and action fields must belong to the same signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `group_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **group_id** or **field_id** is required, but not both. - -Must reference the ID of an existing group defined within `form_field_groups`. - -Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer. REPLACE_ME_WITH_DESCRIPTION_END | | +| `hidden`*_required_ | ```bool``` | `true` to hide the target field when rule is satisfied, otherwise `false`. | | +| `type`*_required_ | ```string``` | | | +| `field_id` | ```string``` | **field_id** or **group_id** is required, but not both.

Must reference the `api_id` of an existing field defined within `form_fields_per_document`.

Cannot use with `group_id`. Trigger and action fields must belong to the same signer. | | +| `group_id` | ```string``` | **group_id** or **field_id** is required, but not both.

Must reference the ID of an existing group defined within `form_field_groups`.

Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldRuleTrigger.md b/sdks/php/docs/Model/SubFormFieldRuleTrigger.md index 88b155f26..da2141ef0 100644 --- a/sdks/php/docs/Model/SubFormFieldRuleTrigger.md +++ b/sdks/php/docs/Model/SubFormFieldRuleTrigger.md @@ -6,42 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `operator`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Different field types allow different `operator` values: -- Field type of **text**: - - **is**: exact match - - **not**: not exact match - - **match**: regular expression, without /. Example: - - OK `[a-zA-Z0-9]` - - Not OK `/[a-zA-Z0-9]/` -- Field type of **dropdown**: - - **is**: exact match, single value - - **not**: not exact match, single value - - **any**: exact match, array of values. - - **none**: not exact match, array of values. -- Field type of **checkbox**: - - **is**: exact match, single value - - **not**: not exact match, single value -- Field type of **radio**: - - **is**: exact match, single value - - **not**: not exact match, single value REPLACE_ME_WITH_DESCRIPTION_END | | -| `value` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **value** or **values** is required, but not both. - -The value to match against **operator**. - -- When **operator** is one of the following, **value** must be `String`: - - `is` - - `not` - - `match` - -Otherwise, -- **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` -- **radio**: When **type** of trigger is **radio**, **value** must be `1` REPLACE_ME_WITH_DESCRIPTION_END | | -| `values` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **values** or **value** is required, but not both. - -The values to match against **operator** when it is one of the following: - -- `any` -- `none` REPLACE_ME_WITH_DESCRIPTION_END | | +| `id`*_required_ | ```string``` | Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer. | | +| `operator`*_required_ | ```string``` | Different field types allow different `operator` values: - Field type of **text**: - **is**: exact match - **not**: not exact match - **match**: regular expression, without /. Example: - OK `[a-zA-Z0-9]` - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**: - **is**: exact match, single value - **not**: not exact match, single value - **any**: exact match, array of values. - **none**: not exact match, array of values. - Field type of **checkbox**: - **is**: exact match, single value - **not**: not exact match, single value - Field type of **radio**: - **is**: exact match, single value - **not**: not exact match, single value | | +| `value` | ```string``` | **value** or **values** is required, but not both.

The value to match against **operator**.

- When **operator** is one of the following, **value** must be `String`: - `is` - `not` - `match`

Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1` | | +| `values` | ```string[]``` | **values** or **value** is required, but not both.

The values to match against **operator** when it is one of the following:

- `any` - `none` | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md index 5381de32c..7c7f4c293 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md @@ -4,38 +4,31 @@ The fields that should appear on the document, expressed as an array of objects. **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. -* Text Field use `SubFormFieldsPerDocumentText` -* Dropdown Field use `SubFormFieldsPerDocumentDropdown` -* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` -* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` -* Radio Field use `SubFormFieldsPerDocumentRadio` -* Signature Field use `SubFormFieldsPerDocumentSignature` -* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` -* Initials Field use `SubFormFieldsPerDocumentInitials` -* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` -* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` +* Text Field use `SubFormFieldsPerDocumentText` +* Dropdown Field use `SubFormFieldsPerDocumentDropdown` +* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` +* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` +* Radio Field use `SubFormFieldsPerDocumentRadio` +* Signature Field use `SubFormFieldsPerDocumentSignature` +* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` +* Initials Field use `SubFormFieldsPerDocumentInitials` +* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` +* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `document_index`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Represents the integer index of the `file` or `file_url` document the field should be attached to. REPLACE_ME_WITH_DESCRIPTION_END | | -| `api_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An identifier for the field that is unique across all documents in the request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `height`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Size of the field in pixels. REPLACE_ME_WITH_DESCRIPTION_END | | -| `required`*_required_ | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. - -**NOTE:** To set the value of the field as the preparer you must set this to `me_now` - -**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. REPLACE_ME_WITH_DESCRIPTION_END | | -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `width`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Size of the field in pixels. REPLACE_ME_WITH_DESCRIPTION_END | | -| `x`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Location coordinates of the field in pixels. REPLACE_ME_WITH_DESCRIPTION_END | | -| `y`*_required_ | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Location coordinates of the field in pixels. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Display name for the field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `page` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Page in the document where the field should be placed (requires documents be PDF files). - -- When the page number parameter is supplied, the API will use the new coordinate system. -- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. REPLACE_ME_WITH_DESCRIPTION_END | | +| `document_index`*_required_ | ```int``` | Represents the integer index of the `file` or `file_url` document the field should be attached to. | | +| `api_id`*_required_ | ```string``` | An identifier for the field that is unique across all documents in the request. | | +| `height`*_required_ | ```int``` | Size of the field in pixels. | | +| `required`*_required_ | ```bool``` | Whether this field is required. | | +| `signer`*_required_ | ```string``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | | +| `type`*_required_ | ```string``` | | | +| `width`*_required_ | ```int``` | Size of the field in pixels. | | +| `x`*_required_ | ```int``` | Location coordinates of the field in pixels. | | +| `y`*_required_ | ```int``` | Location coordinates of the field in pixels. | | +| `name` | ```string``` | Display name for the field. | | +| `page` | ```int``` | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckbox.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckbox.md index e3c9f2f0a..57e306cbf 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckbox.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckbox.md @@ -1,13 +1,13 @@ # # SubFormFieldsPerDocumentCheckbox -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | -| `is_checked`*_required_ | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `true` for checking the checkbox field by default, otherwise `false`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN String referencing group defined in `form_field_groups` parameter. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class. | [default to 'checkbox'] | +| `is_checked`*_required_ | ```bool``` | `true` for checking the checkbox field by default, otherwise `false`. | | +| `group` | ```string``` | String referencing group defined in `form_field_groups` parameter. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckboxMerge.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckboxMerge.md index a37b87afa..d959793a0 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckboxMerge.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentCheckboxMerge.md @@ -1,11 +1,11 @@ # # SubFormFieldsPerDocumentCheckboxMerge -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox-merge'] | +| `type`*_required_ | ```string``` | A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class. | [default to 'checkbox-merge'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentDateSigned.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentDateSigned.md index d8eba3f97..d33f346ce 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentDateSigned.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentDateSigned.md @@ -1,15 +1,13 @@ # # SubFormFieldsPerDocumentDateSigned -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A date. Use the `SubFormFieldsPerDocumentDateSigned` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'date_signed'] | -| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family for the field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The initial px font size for the field contents. Can be any integer value between `7` and `49`. - -**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 12] | +| `type`*_required_ | ```string``` | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | [default to 'date_signed'] | +| `font_family` | ```string``` | Font family for the field. | | +| `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentDropdown.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentDropdown.md index e8ea4e2ca..c670a097e 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentDropdown.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentDropdown.md @@ -1,17 +1,15 @@ # # SubFormFieldsPerDocumentDropdown -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'dropdown'] | -| `options`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Array of string values representing dropdown values. REPLACE_ME_WITH_DESCRIPTION_END | | -| `content` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Selected value in `options` array. Value must exist in array. REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family for the field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The initial px font size for the field contents. Can be any integer value between `7` and `49`. - -**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 12] | +| `type`*_required_ | ```string``` | An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class. | [default to 'dropdown'] | +| `options`*_required_ | ```string[]``` | Array of string values representing dropdown values. | | +| `content` | ```string``` | Selected value in `options` array. Value must exist in array. | | +| `font_family` | ```string``` | Font family for the field. | | +| `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentHyperlink.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentHyperlink.md index 4dd186a61..0cb90a64f 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentHyperlink.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentHyperlink.md @@ -1,17 +1,15 @@ # # SubFormFieldsPerDocumentHyperlink -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'hyperlink'] | -| `content`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Link Text. REPLACE_ME_WITH_DESCRIPTION_END | | -| `content_url`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Link URL. REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family for the field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The initial px font size for the field contents. Can be any integer value between `7` and `49`. - -**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 12] | +| `type`*_required_ | ```string``` | A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. | [default to 'hyperlink'] | +| `content`*_required_ | ```string``` | Link Text. | | +| `content_url`*_required_ | ```string``` | Link URL. | | +| `font_family` | ```string``` | Font family for the field. | | +| `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentInitials.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentInitials.md index 7c33a53b7..ccb50121e 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentInitials.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentInitials.md @@ -1,11 +1,11 @@ # # SubFormFieldsPerDocumentInitials -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'initials'] | +| `type`*_required_ | ```string``` | An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class. | [default to 'initials'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentRadio.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentRadio.md index 097e3ce13..6d40f86e6 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentRadio.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentRadio.md @@ -1,13 +1,13 @@ # # SubFormFieldsPerDocumentRadio -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'radio'] | -| `group`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN String referencing group defined in `form_field_groups` parameter. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_checked`*_required_ | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class. | [default to 'radio'] | +| `group`*_required_ | ```string``` | String referencing group defined in `form_field_groups` parameter. | | +| `is_checked`*_required_ | ```bool``` | `true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentSignature.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentSignature.md index c85f68728..9b800232f 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentSignature.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentSignature.md @@ -1,11 +1,11 @@ # # SubFormFieldsPerDocumentSignature -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A signature input field. Use the `SubFormFieldsPerDocumentSignature` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'signature'] | +| `type`*_required_ | ```string``` | A signature input field. Use the `SubFormFieldsPerDocumentSignature` class. | [default to 'signature'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md index 466789871..c41a60817 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md @@ -1,25 +1,21 @@ # # SubFormFieldsPerDocumentText -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A text input field. Use the `SubFormFieldsPerDocumentText` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | -| `placeholder` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Placeholder value for text field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `auto_fill_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. REPLACE_ME_WITH_DESCRIPTION_END | | -| `link_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. REPLACE_ME_WITH_DESCRIPTION_END | | -| `masked` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `validation_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. - -**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. REPLACE_ME_WITH_DESCRIPTION_END | | -| `validation_custom_regex` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `validation_custom_regex_format_label` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `content` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Content of a `me_now` text field REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family for the field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The initial px font size for the field contents. Can be any integer value between `7` and `49`. - -**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 12] | +| `type`*_required_ | ```string``` | A text input field. Use the `SubFormFieldsPerDocumentText` class. | [default to 'text'] | +| `placeholder` | ```string``` | Placeholder value for text field. | | +| `auto_fill_type` | ```string``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | | +| `link_id` | ```string``` | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | | +| `masked` | ```bool``` | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | | +| `validation_type` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.

**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | | +| `validation_custom_regex` | ```string``` | | | +| `validation_custom_regex_format_label` | ```string``` | | | +| `content` | ```string``` | Content of a `me_now` text field | | +| `font_family` | ```string``` | Font family for the field. | | +| `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md index e4036697d..40c07308f 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md @@ -1,15 +1,13 @@ # # SubFormFieldsPerDocumentTextMerge -This class extends `SubFormFieldsPerDocumentBase`. +This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text-merge'] | -| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family for the field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The initial px font size for the field contents. Can be any integer value between `7` and `49`. - -**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 12] | +| `type`*_required_ | ```string``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] | +| `font_family` | ```string``` | Font family for the field. | | +| `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubMergeField.md b/sdks/php/docs/Model/SubMergeField.md index 1236c2712..1114a084b 100644 --- a/sdks/php/docs/Model/SubMergeField.md +++ b/sdks/php/docs/Model/SubMergeField.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the merge field. Must be unique. REPLACE_ME_WITH_DESCRIPTION_END | | -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of merge field. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name`*_required_ | ```string``` | The name of the merge field. Must be unique. | | +| `type`*_required_ | ```string``` | The type of merge field. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubOAuth.md b/sdks/php/docs/Model/SubOAuth.md index 48ee87f15..26088e668 100644 --- a/sdks/php/docs/Model/SubOAuth.md +++ b/sdks/php/docs/Model/SubOAuth.md @@ -6,7 +6,7 @@ OAuth related parameters. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) REPLACE_ME_WITH_DESCRIPTION_END | | -| `scopes` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). REPLACE_ME_WITH_DESCRIPTION_END | | +| `callback_url` | ```string``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | | +| `scopes` | ```string[]``` | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubOptions.md b/sdks/php/docs/Model/SubOptions.md index 5b1d68b42..926c89eab 100644 --- a/sdks/php/docs/Model/SubOptions.md +++ b/sdks/php/docs/Model/SubOptions.md @@ -6,6 +6,6 @@ Additional options supported by API App. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Determines if signers can use "Insert Everywhere" when signing a document. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `can_insert_everywhere` | ```bool``` | Determines if signers can use "Insert Everywhere" when signing a document. | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md b/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md index 9dc8e7ed0..69275147a 100644 --- a/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md +++ b/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md @@ -6,10 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `group`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signers belonging to this Group. - -**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. REPLACE_ME_WITH_DESCRIPTION_END | | -| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The order the group is required to sign in. Use this instead of Signer-level `order`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `group`*_required_ | ```string``` | The name of the group. | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Signers belonging to this Group.

**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. | | +| `order` | ```int``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSignatureRequestSigner.md b/sdks/php/docs/Model/SubSignatureRequestSigner.md index ffb1380f1..8ba880dd0 100644 --- a/sdks/php/docs/Model/SubSignatureRequestSigner.md +++ b/sdks/php/docs/Model/SubSignatureRequestSigner.md @@ -6,19 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The order the signer is required to sign in. REPLACE_ME_WITH_DESCRIPTION_END | | -| `pin` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The 4- to 12-character access code that will secure this signer's signature page. REPLACE_ME_WITH_DESCRIPTION_END | | -| `sms_phone_number` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An E.164 formatted phone number. - -By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - -**NOTE:** Not available in test mode and requires a Standard plan or higher. REPLACE_ME_WITH_DESCRIPTION_END | | -| `sms_phone_number_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Specifies the feature used with the `sms_phone_number`. Default `authentication`. - -If `authentication`, signer is sent a verification code via SMS that is required to access the document. - -If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). REPLACE_ME_WITH_DESCRIPTION_END | | +| `name`*_required_ | ```string``` | The name of the signer. | | +| `email_address`*_required_ | ```string``` | The email address of the signer. | | +| `order` | ```int``` | The order the signer is required to sign in. | | +| `pin` | ```string``` | The 4- to 12-character access code that will secure this signer's signature page. | | +| `sms_phone_number` | ```string``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | +| `sms_phone_number_type` | ```string``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md b/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md index 276f5dec8..5b1995c0b 100644 --- a/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md +++ b/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md @@ -6,19 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Must match an existing role in chosen Template(s). It's case-sensitive. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `pin` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The 4- to 12-character access code that will secure this signer's signature page. REPLACE_ME_WITH_DESCRIPTION_END | | -| `sms_phone_number` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN An E.164 formatted phone number. - -By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - -**NOTE:** Not available in test mode and requires a Standard plan or higher. REPLACE_ME_WITH_DESCRIPTION_END | | -| `sms_phone_number_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Specifies the feature used with the `sms_phone_number`. Default `authentication`. - -If `authentication`, signer is sent a verification code via SMS that is required to access the document. - -If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). REPLACE_ME_WITH_DESCRIPTION_END | | +| `role`*_required_ | ```string``` | Must match an existing role in chosen Template(s). It's case-sensitive. | | +| `name`*_required_ | ```string``` | The name of the signer. | | +| `email_address`*_required_ | ```string``` | The email address of the signer. | | +| `pin` | ```string``` | The 4- to 12-character access code that will secure this signer's signature page. | | +| `sms_phone_number` | ```string``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | +| `sms_phone_number_type` | ```string``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSigningOptions.md b/sdks/php/docs/Model/SubSigningOptions.md index 56cb56434..e2a1b1660 100644 --- a/sdks/php/docs/Model/SubSigningOptions.md +++ b/sdks/php/docs/Model/SubSigningOptions.md @@ -2,16 +2,16 @@ This allows the requester to specify the types allowed for creating a signature. -**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `default_type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The default type shown (limited to the listed types) REPLACE_ME_WITH_DESCRIPTION_END | | -| `draw` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows drawing the signature REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `phone` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows using a smartphone to email the signature REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `type` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows typing the signature REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `upload` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows uploading the signature REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `default_type`*_required_ | ```string``` | The default type shown (limited to the listed types) | | +| `draw` | ```bool``` | Allows drawing the signature | [default to false] | +| `phone` | ```bool``` | Allows using a smartphone to email the signature | [default to false] | +| `type` | ```bool``` | Allows typing the signature | [default to false] | +| `upload` | ```bool``` | Allows uploading the signature | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubTeamResponse.md b/sdks/php/docs/Model/SubTeamResponse.md index 659e96685..e0c954d29 100644 --- a/sdks/php/docs/Model/SubTeamResponse.md +++ b/sdks/php/docs/Model/SubTeamResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of a team REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of a team REPLACE_ME_WITH_DESCRIPTION_END | | +| `team_id` | ```string``` | The id of a team | | +| `name` | ```string``` | The name of a team | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubTemplateRole.md b/sdks/php/docs/Model/SubTemplateRole.md index d24f7e99b..062527156 100644 --- a/sdks/php/docs/Model/SubTemplateRole.md +++ b/sdks/php/docs/Model/SubTemplateRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The role name of the signer that will be displayed when the template is used to create a signature request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The order in which this signer role is required to sign. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | The role name of the signer that will be displayed when the template is used to create a signature request. | | +| `order` | ```int``` | The order in which this signer role is required to sign. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubUnclaimedDraftSigner.md b/sdks/php/docs/Model/SubUnclaimedDraftSigner.md index 6e4c6270a..d5849d712 100644 --- a/sdks/php/docs/Model/SubUnclaimedDraftSigner.md +++ b/sdks/php/docs/Model/SubUnclaimedDraftSigner.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer. REPLACE_ME_WITH_DESCRIPTION_END | | -| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The order the signer is required to sign in. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address`*_required_ | ```string``` | The email address of the signer. | | +| `name`*_required_ | ```string``` | The name of the signer. | | +| `order` | ```int``` | The order the signer is required to sign in. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md b/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md index 942d15c1c..3c20fd2e7 100644 --- a/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md +++ b/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Must match an existing role in chosen Template(s). REPLACE_ME_WITH_DESCRIPTION_END | | -| `name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the signer filling the role of `role`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the signer filling the role of `role`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `role`*_required_ | ```string``` | Must match an existing role in chosen Template(s). | | +| `name`*_required_ | ```string``` | The name of the signer filling the role of `role`. | | +| `email_address`*_required_ | ```string``` | The email address of the signer filling the role of `role`. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubWhiteLabelingOptions.md b/sdks/php/docs/Model/SubWhiteLabelingOptions.md index 4319bed5b..976f55aaa 100644 --- a/sdks/php/docs/Model/SubWhiteLabelingOptions.md +++ b/sdks/php/docs/Model/SubWhiteLabelingOptions.md @@ -8,20 +8,20 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `header_background_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#1a1a1a'] | -| `legal_version` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to 'terms1'] | -| `link_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#0061FE'] | -| `page_background_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#f7f8f9'] | -| `primary_button_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#0061FE'] | -| `primary_button_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#0061FE'] | -| `primary_button_text_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#ffffff'] | -| `primary_button_text_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#ffffff'] | -| `secondary_button_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#ffffff'] | -| `secondary_button_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#ffffff'] | -| `secondary_button_text_color` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#0061FE'] | -| `secondary_button_text_color_hover` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#0061FE'] | -| `text_color1` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#808080'] | -| `text_color2` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | [default to '#ffffff'] | -| `reset_to_default` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Resets white labeling options to defaults. Only useful when updating an API App. REPLACE_ME_WITH_DESCRIPTION_END | | +| `header_background_color` | ```string``` | | [default to '#1a1a1a'] | +| `legal_version` | ```string``` | | [default to 'terms1'] | +| `link_color` | ```string``` | | [default to '#0061FE'] | +| `page_background_color` | ```string``` | | [default to '#f7f8f9'] | +| `primary_button_color` | ```string``` | | [default to '#0061FE'] | +| `primary_button_color_hover` | ```string``` | | [default to '#0061FE'] | +| `primary_button_text_color` | ```string``` | | [default to '#ffffff'] | +| `primary_button_text_color_hover` | ```string``` | | [default to '#ffffff'] | +| `secondary_button_color` | ```string``` | | [default to '#ffffff'] | +| `secondary_button_color_hover` | ```string``` | | [default to '#ffffff'] | +| `secondary_button_text_color` | ```string``` | | [default to '#0061FE'] | +| `secondary_button_text_color_hover` | ```string``` | | [default to '#0061FE'] | +| `text_color1` | ```string``` | | [default to '#808080'] | +| `text_color2` | ```string``` | | [default to '#ffffff'] | +| `reset_to_default` | ```bool``` | Resets white labeling options to defaults. Only useful when updating an API App. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamAddMemberRequest.md b/sdks/php/docs/Model/TeamAddMemberRequest.md index 3f0b39137..4606ecdcb 100644 --- a/sdks/php/docs/Model/TeamAddMemberRequest.md +++ b/sdks/php/docs/Model/TeamAddMemberRequest.md @@ -6,14 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `account_id` or `email_address` is required. If both are provided, the account id prevails. - -Account id of the user to invite to your Team. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `account_id` or `email_address` is required, If both are provided, the account id prevails. - -Email address of the user to invite to your Team. REPLACE_ME_WITH_DESCRIPTION_END | | -| `role` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A role member will take in a new Team. - -**NOTE:** This parameter is used only if `team_id` is provided. REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | `account_id` or `email_address` is required. If both are provided, the account id prevails.

Account id of the user to invite to your Team. | | +| `email_address` | ```string``` | `account_id` or `email_address` is required, If both are provided, the account id prevails.

Email address of the user to invite to your Team. | | +| `role` | ```string``` | A role member will take in a new Team.

**NOTE:** This parameter is used only if `team_id` is provided. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamCreateRequest.md b/sdks/php/docs/Model/TeamCreateRequest.md index 46d4cc0d2..29c05f9a3 100644 --- a/sdks/php/docs/Model/TeamCreateRequest.md +++ b/sdks/php/docs/Model/TeamCreateRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of your Team. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'Untitled Team'] | +| `name` | ```string``` | The name of your Team. | [default to 'Untitled Team'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamGetInfoResponse.md b/sdks/php/docs/Model/TeamGetInfoResponse.md index a2757b114..6250ae721 100644 --- a/sdks/php/docs/Model/TeamGetInfoResponse.md +++ b/sdks/php/docs/Model/TeamGetInfoResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team`*_required_ | [```\Dropbox\Sign\Model\TeamInfoResponse```](TeamInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `team`*_required_ | [```\Dropbox\Sign\Model\TeamInfoResponse```](TeamInfoResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamGetResponse.md b/sdks/php/docs/Model/TeamGetResponse.md index b5bcac844..0d65f9000 100644 --- a/sdks/php/docs/Model/TeamGetResponse.md +++ b/sdks/php/docs/Model/TeamGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team`*_required_ | [```\Dropbox\Sign\Model\TeamResponse```](TeamResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `team`*_required_ | [```\Dropbox\Sign\Model\TeamResponse```](TeamResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamInfoResponse.md b/sdks/php/docs/Model/TeamInfoResponse.md index c44fc478d..6db4a64c2 100644 --- a/sdks/php/docs/Model/TeamInfoResponse.md +++ b/sdks/php/docs/Model/TeamInfoResponse.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of a team REPLACE_ME_WITH_DESCRIPTION_END | | -| `team_parent` | [```\Dropbox\Sign\Model\TeamParentResponse```](TeamParentResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of a team REPLACE_ME_WITH_DESCRIPTION_END | | -| `num_members` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of members within a team REPLACE_ME_WITH_DESCRIPTION_END | | -| `num_sub_teams` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of sub teams within a team REPLACE_ME_WITH_DESCRIPTION_END | | +| `team_id` | ```string``` | The id of a team | | +| `team_parent` | [```\Dropbox\Sign\Model\TeamParentResponse```](TeamParentResponse.md) | | | +| `name` | ```string``` | The name of a team | | +| `num_members` | ```int``` | Number of members within a team | | +| `num_sub_teams` | ```int``` | Number of sub teams within a team | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamInviteResponse.md b/sdks/php/docs/Model/TeamInviteResponse.md index cd33f7af0..6ca84d844 100644 --- a/sdks/php/docs/Model/TeamInviteResponse.md +++ b/sdks/php/docs/Model/TeamInviteResponse.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address of the user invited to this team. REPLACE_ME_WITH_DESCRIPTION_END | | -| `team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Id of the team. REPLACE_ME_WITH_DESCRIPTION_END | | -| `role` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Role of the user invited to this team. REPLACE_ME_WITH_DESCRIPTION_END | | -| `sent_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Timestamp when the invitation was sent. REPLACE_ME_WITH_DESCRIPTION_END | | -| `redeemed_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Timestamp when the invitation was redeemed. REPLACE_ME_WITH_DESCRIPTION_END | | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Timestamp when the invitation is expiring. REPLACE_ME_WITH_DESCRIPTION_END | | +| `email_address` | ```string``` | Email address of the user invited to this team. | | +| `team_id` | ```string``` | Id of the team. | | +| `role` | ```string``` | Role of the user invited to this team. | | +| `sent_at` | ```int``` | Timestamp when the invitation was sent. | | +| `redeemed_at` | ```int``` | Timestamp when the invitation was redeemed. | | +| `expires_at` | ```int``` | Timestamp when the invitation is expiring. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamInvitesResponse.md b/sdks/php/docs/Model/TeamInvitesResponse.md index f2f17bbaa..64d96b25b 100644 --- a/sdks/php/docs/Model/TeamInvitesResponse.md +++ b/sdks/php/docs/Model/TeamInvitesResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_invites`*_required_ | [```\Dropbox\Sign\Model\TeamInviteResponse[]```](TeamInviteResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains a list of team invites and their roles. REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `team_invites`*_required_ | [```\Dropbox\Sign\Model\TeamInviteResponse[]```](TeamInviteResponse.md) | Contains a list of team invites and their roles. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamMemberResponse.md b/sdks/php/docs/Model/TeamMemberResponse.md index 4c8fcd70d..2ff4a44f9 100644 --- a/sdks/php/docs/Model/TeamMemberResponse.md +++ b/sdks/php/docs/Model/TeamMemberResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Account id of the team member. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Email address of the team member. REPLACE_ME_WITH_DESCRIPTION_END | | -| `role` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The specific role a member has on the team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | Account id of the team member. | | +| `email_address` | ```string``` | Email address of the team member. | | +| `role` | ```string``` | The specific role a member has on the team. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamMembersResponse.md b/sdks/php/docs/Model/TeamMembersResponse.md index 23bf36e60..0474722c4 100644 --- a/sdks/php/docs/Model/TeamMembersResponse.md +++ b/sdks/php/docs/Model/TeamMembersResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_members`*_required_ | [```\Dropbox\Sign\Model\TeamMemberResponse[]```](TeamMemberResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains a list of team members and their roles for a specific team. REPLACE_ME_WITH_DESCRIPTION_END | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `team_members`*_required_ | [```\Dropbox\Sign\Model\TeamMemberResponse[]```](TeamMemberResponse.md) | Contains a list of team members and their roles for a specific team. | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamParentResponse.md b/sdks/php/docs/Model/TeamParentResponse.md index 241255572..376880069 100644 --- a/sdks/php/docs/Model/TeamParentResponse.md +++ b/sdks/php/docs/Model/TeamParentResponse.md @@ -1,12 +1,12 @@ # # TeamParentResponse -Information about the parent team if a team has one, set to `null` otherwise. +Information about the parent team if a team has one, set to `null` otherwise. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of a team REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of a team REPLACE_ME_WITH_DESCRIPTION_END | | +| `team_id` | ```string``` | The id of a team | | +| `name` | ```string``` | The name of a team | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamRemoveMemberRequest.md b/sdks/php/docs/Model/TeamRemoveMemberRequest.md index 5f11d2f0b..39672f4b2 100644 --- a/sdks/php/docs/Model/TeamRemoveMemberRequest.md +++ b/sdks/php/docs/Model/TeamRemoveMemberRequest.md @@ -6,18 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **account_id** or **email_address** is required. If both are provided, the account id prevails. - -Account id to remove from your Team. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN **account_id** or **email_address** is required. If both are provided, the account id prevails. - -Email address of the Account to remove from your Team. REPLACE_ME_WITH_DESCRIPTION_END | | -| `new_owner_email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account. - -**NOTE:** Only available for Enterprise plans. REPLACE_ME_WITH_DESCRIPTION_END | | -| `new_team_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Id of the new Team. REPLACE_ME_WITH_DESCRIPTION_END | | -| `new_role` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A new role member will take in a new Team. - -**NOTE:** This parameter is used only if `new_team_id` is provided. REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | **account_id** or **email_address** is required. If both are provided, the account id prevails.

Account id to remove from your Team. | | +| `email_address` | ```string``` | **account_id** or **email_address** is required. If both are provided, the account id prevails.

Email address of the Account to remove from your Team. | | +| `new_owner_email_address` | ```string``` | The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.

**NOTE:** Only available for Enterprise plans. | | +| `new_team_id` | ```string``` | Id of the new Team. | | +| `new_role` | ```string``` | A new role member will take in a new Team.

**NOTE:** This parameter is used only if `new_team_id` is provided. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamResponse.md b/sdks/php/docs/Model/TeamResponse.md index 5929025f0..4aea582c9 100644 --- a/sdks/php/docs/Model/TeamResponse.md +++ b/sdks/php/docs/Model/TeamResponse.md @@ -6,9 +6,9 @@ Contains information about your team and its members Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of your Team REPLACE_ME_WITH_DESCRIPTION_END | | -| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `invited_accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `invited_emails` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | The name of your Team | | +| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | +| `invited_accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invited_emails` | ```string[]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamSubTeamsResponse.md b/sdks/php/docs/Model/TeamSubTeamsResponse.md index f30690d36..9a37ce150 100644 --- a/sdks/php/docs/Model/TeamSubTeamsResponse.md +++ b/sdks/php/docs/Model/TeamSubTeamsResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `sub_teams`*_required_ | [```\Dropbox\Sign\Model\SubTeamResponse[]```](SubTeamResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Contains a list with sub teams. REPLACE_ME_WITH_DESCRIPTION_END | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `sub_teams`*_required_ | [```\Dropbox\Sign\Model\SubTeamResponse[]```](SubTeamResponse.md) | Contains a list with sub teams. | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamUpdateRequest.md b/sdks/php/docs/Model/TeamUpdateRequest.md index b171fa684..604a6012f 100644 --- a/sdks/php/docs/Model/TeamUpdateRequest.md +++ b/sdks/php/docs/Model/TeamUpdateRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of your Team. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | The name of your Team. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateAddUserRequest.md b/sdks/php/docs/Model/TemplateAddUserRequest.md index 8c2d00bb9..e552d463d 100644 --- a/sdks/php/docs/Model/TemplateAddUserRequest.md +++ b/sdks/php/docs/Model/TemplateAddUserRequest.md @@ -6,10 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Account to give access to the Template. -**NOTE:** The account id prevails if email address is also provided. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the Account to give access to the Template. -**NOTE:** The account id prevails if it is also provided. REPLACE_ME_WITH_DESCRIPTION_END | | -| `skip_notification` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `account_id` | ```string``` | The id of the Account to give access to the Template.
**NOTE:** The account id prevails if email address is also provided. | | +| `email_address` | ```string``` | The email address of the Account to give access to the Template.
**NOTE:** The account id prevails if it is also provided. | | +| `skip_notification` | ```bool``` | If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`. | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md index 159835621..d9ef188de 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md @@ -6,55 +6,30 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_ccs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | -| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. - -**NOTE:** Only available for Premium plan and higher. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | -| `cc_roles` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The CC roles that must be assigned when using the template to send a signature request REPLACE_ME_WITH_DESCRIPTION_END | | -| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `force_signer_roles` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template signer roles. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `force_subject_message` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template subject and message. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) - -**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. - -* Text Field use `SubFormFieldsPerDocumentText` -* Dropdown Field use `SubFormFieldsPerDocumentDropdown` -* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` -* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` -* Radio Field use `SubFormFieldsPerDocumentRadio` -* Signature Field use `SubFormFieldsPerDocumentSignature` -* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` -* Initials Field use `SubFormFieldsPerDocumentInitials` -* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` -* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | -| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. -If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. REPLACE_ME_WITH_DESCRIPTION_END | | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The default template email message. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `show_preview` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the editor/preview experience. - -- `show_preview=true`: Allows requesters to enable the editor/preview experience. -- `show_preview=false`: Allows requesters to disable the editor/preview experience. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | -| `signer_roles` | [```\Dropbox\Sign\Model\SubTemplateRole[]```](SubTemplateRole.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `skip_me_now` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The template title (alias). REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `use_preexisting_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `client_id`*_required_ | ```string``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to true] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request | | +| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | +| `force_signer_roles` | ```bool``` | Provide users the ability to review/edit the template signer roles. | [default to false] | +| `force_subject_message` | ```bool``` | Provide users the ability to review/edit the template subject and message. | [default to false] | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | +| `message` | ```string``` | The default template email message. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] | +| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | +| `signer_roles` | [```\Dropbox\Sign\Model\SubTemplateRole[]```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `skip_me_now` | ```bool``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | +| `subject` | ```string``` | The template title (alias). | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md index f2a052175..439aa708e 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md index 18c368d45..7604fd299 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -1,14 +1,14 @@ # # TemplateCreateEmbeddedDraftResponseTemplate -Template object with parameters: `template_id`, `edit_url`, `expires_at`. +Template object with parameters: `template_id`, `edit_url`, `expires_at`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `edit_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Link to edit the template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the link expires. REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_id` | ```string``` | The id of the Template. | | +| `edit_url` | ```string``` | Link to edit the template. | | +| `expires_at` | ```int``` | When the link expires. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateRequest.md b/sdks/php/docs/Model/TemplateCreateRequest.md index e962f4486..1a4b677f1 100644 --- a/sdks/php/docs/Model/TemplateCreateRequest.md +++ b/sdks/php/docs/Model/TemplateCreateRequest.md @@ -6,45 +6,23 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `form_fields_per_document`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) - -**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. - -* Text Field use `SubFormFieldsPerDocumentText` -* Dropdown Field use `SubFormFieldsPerDocumentDropdown` -* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` -* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` -* Radio Field use `SubFormFieldsPerDocumentRadio` -* Signature Field use `SubFormFieldsPerDocumentSignature` -* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` -* Initials Field use `SubFormFieldsPerDocumentInitials` -* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` -* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_roles`*_required_ | [```\Dropbox\Sign\Model\SubTemplateRole[]```](SubTemplateRole.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. - -**NOTE:** Only available for Premium plan and higher. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | -| `cc_roles` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The CC roles that must be assigned when using the template to send a signature request REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. -If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. REPLACE_ME_WITH_DESCRIPTION_END | | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The default template email message. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The template title (alias). REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `use_preexisting_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `form_fields_per_document`*_required_ | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `signer_roles`*_required_ | [```\Dropbox\Sign\Model\SubTemplateRole[]```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request | | +| `client_id` | ```string``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | +| `message` | ```string``` | The default template email message. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `subject` | ```string``` | The template title (alias). | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateResponse.md b/sdks/php/docs/Model/TemplateCreateResponse.md index 1c77743b1..676d2acca 100644 --- a/sdks/php/docs/Model/TemplateCreateResponse.md +++ b/sdks/php/docs/Model/TemplateCreateResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md index a290126c2..0f25586c5 100644 --- a/sdks/php/docs/Model/TemplateCreateResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md @@ -1,11 +1,11 @@ # # TemplateCreateResponseTemplate -Template object with parameters: `template_id`. +Template object with parameters: `template_id`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_id` | ```string``` | The id of the Template. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateEditResponse.md b/sdks/php/docs/Model/TemplateEditResponse.md index 587ed6b24..b343db573 100644 --- a/sdks/php/docs/Model/TemplateEditResponse.md +++ b/sdks/php/docs/Model/TemplateEditResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_id`*_required_ | ```string``` | The id of the Template. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateGetResponse.md b/sdks/php/docs/Model/TemplateGetResponse.md index 425abd9bb..0aba7b381 100644 --- a/sdks/php/docs/Model/TemplateGetResponse.md +++ b/sdks/php/docs/Model/TemplateGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse```](TemplateResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse```](TemplateResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateListResponse.md b/sdks/php/docs/Model/TemplateListResponse.md index 7a943c864..9723b1385 100644 --- a/sdks/php/docs/Model/TemplateListResponse.md +++ b/sdks/php/docs/Model/TemplateListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse[]```](TemplateResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN List of templates that the API caller has access to. REPLACE_ME_WITH_DESCRIPTION_END | | -| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `templates`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse[]```](TemplateResponse.md) | List of templates that the API caller has access to. | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateRemoveUserRequest.md b/sdks/php/docs/Model/TemplateRemoveUserRequest.md index 4991df58e..591eb5d25 100644 --- a/sdks/php/docs/Model/TemplateRemoveUserRequest.md +++ b/sdks/php/docs/Model/TemplateRemoveUserRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | | +| `email_address` | ```string``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponse.md b/sdks/php/docs/Model/TemplateResponse.md index 9f1695b82..3a7dc2f03 100644 --- a/sdks/php/docs/Model/TemplateResponse.md +++ b/sdks/php/docs/Model/TemplateResponse.md @@ -6,23 +6,21 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `updated_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Time the template was last updated. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_embedded` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_creator` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN `true` if you are the owner of this template, `false` if it's been shared with you by a team member. REPLACE_ME_WITH_DESCRIPTION_END | | -| `can_edit` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_locked` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Indicates whether the template is locked. -If `true`, then the template was created outside your quota and can only be used in `test_mode`. -If `false`, then the template is within your quota and can be used to create signature requests. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The metadata attached to the template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `documents` | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array describing each document associated with this Template. Includes form field data for each document. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. REPLACE_ME_WITH_DESCRIPTION_END | | -| `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. REPLACE_ME_WITH_DESCRIPTION_END | | -| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of the Accounts that can use this Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signer attachments. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_id` | ```string``` | The id of the Template. | | +| `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `updated_at` | ```int``` | Time the template was last updated. | | +| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | +| `is_creator` | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `can_edit` | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `is_locked` | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata` | ```array``` | The metadata attached to the template. | | +| `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents` | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | +| `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | +| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseAccount.md b/sdks/php/docs/Model/TemplateResponseAccount.md index dc61f7dc7..fb9563bbc 100644 --- a/sdks/php/docs/Model/TemplateResponseAccount.md +++ b/sdks/php/docs/Model/TemplateResponseAccount.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Account. REPLACE_ME_WITH_DESCRIPTION_END | | -| `email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address associated with the Account. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_locked` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has been locked out of their account by a team admin. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_paid_hs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has a paid Dropbox Sign account. REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_paid_hf` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Returns `true` if the user has a paid HelloFax account. REPLACE_ME_WITH_DESCRIPTION_END | | -| `quotas` | [```\Dropbox\Sign\Model\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `account_id` | ```string``` | The id of the Account. | | +| `email_address` | ```string``` | The email address associated with the Account. | | +| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas` | [```\Dropbox\Sign\Model\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseAccountQuota.md b/sdks/php/docs/Model/TemplateResponseAccountQuota.md index f40c26140..7b106a9ac 100644 --- a/sdks/php/docs/Model/TemplateResponseAccountQuota.md +++ b/sdks/php/docs/Model/TemplateResponseAccountQuota.md @@ -6,9 +6,9 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN API templates remaining. REPLACE_ME_WITH_DESCRIPTION_END | | -| `api_signature_requests_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN API signature requests remaining. REPLACE_ME_WITH_DESCRIPTION_END | | -| `documents_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Signature requests remaining. REPLACE_ME_WITH_DESCRIPTION_END | | -| `sms_verifications_left` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN SMS verifications remaining. REPLACE_ME_WITH_DESCRIPTION_END | | +| `templates_left` | ```int``` | API templates remaining. | | +| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | +| `documents_left` | ```int``` | Signature requests remaining. | | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseCCRole.md b/sdks/php/docs/Model/TemplateResponseCCRole.md index 80ff66611..32ad82ef9 100644 --- a/sdks/php/docs/Model/TemplateResponseCCRole.md +++ b/sdks/php/docs/Model/TemplateResponseCCRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the Role. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | The name of the Role. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocument.md b/sdks/php/docs/Model/TemplateResponseDocument.md index d1c5e1f72..ab0518d3a 100644 --- a/sdks/php/docs/Model/TemplateResponseDocument.md +++ b/sdks/php/docs/Model/TemplateResponseDocument.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Name of the associated file. REPLACE_ME_WITH_DESCRIPTION_END | | -| `index` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Document ordering, the lowest index is displayed first and the highest last (0-based indexing). REPLACE_ME_WITH_DESCRIPTION_END | | -| `field_groups` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of Form Field Group objects. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of Form Field objects containing the name and type of each named field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array of Form Field objects containing the name and type of each named field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | Name of the associated file. | | +| `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | +| `field_groups` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md index 1d26d087a..47b5bad52 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md @@ -6,15 +6,15 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `api_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The unique ID for this field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the Custom Field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). REPLACE_ME_WITH_DESCRIPTION_END | | -| `x` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The horizontal offset in pixels for this form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `y` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The vertical offset in pixels for this form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `width` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The width in pixels of this form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `height` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The height in pixels of this form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean showing whether or not this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | -| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | | | +| `api_id` | ```string``` | The unique ID for this field. | | +| `name` | ```string``` | The name of the Custom Field. | | +| `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | +| `x` | ```int``` | The horizontal offset in pixels for this form field. | | +| `y` | ```int``` | The vertical offset in pixels for this form field. | | +| `width` | ```int``` | The width in pixels of this form field. | | +| `height` | ```int``` | The height in pixels of this form field. | | +| `required` | ```bool``` | Boolean showing whether or not this field is required. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md index 931fba73f..4b1e53fb0 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md @@ -1,14 +1,11 @@ # # TemplateResponseDocumentCustomFieldCheckbox -This class extends `TemplateResponseDocumentCustomFieldBase` +This class extends `TemplateResponseDocumentCustomFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this Custom Field. Only `text` and `checkbox` are currently supported. - -* Text uses `TemplateResponseDocumentCustomFieldText` -* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | +| `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'checkbox'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md index 7a49e5846..68e40af6b 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md @@ -1,18 +1,15 @@ # # TemplateResponseDocumentCustomFieldText -This class extends `TemplateResponseDocumentCustomFieldBase` +This class extends `TemplateResponseDocumentCustomFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this Custom Field. Only `text` and `checkbox` are currently supported. - -* Text uses `TemplateResponseDocumentCustomFieldText` -* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_multiline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this form field is multiline text. REPLACE_ME_WITH_DESCRIPTION_END | | -| `original_font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Original font size used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | +| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size` | ```int``` | Original font size used in this form field's text. | | +| `font_family` | ```string``` | Font family used in this form field's text. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md index e312e17b3..233352654 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the form field group. REPLACE_ME_WITH_DESCRIPTION_END | | -| `rule` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | The name of the form field group. | | +| `rule` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md index 9ef7f0ffb..ad79e834e 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md @@ -6,11 +6,7 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Examples: `require_0-1` `require_1` `require_1-ormore` - -- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). -- Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). -- Radio groups require **at least** two fields per group. REPLACE_ME_WITH_DESCRIPTION_END | | -| `group_label` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Name of the group REPLACE_ME_WITH_DESCRIPTION_END | | +| `requirement` | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_label` | ```string``` | Name of the group | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md index 23baa5753..f792fdfed 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md @@ -6,14 +6,14 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `api_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A unique id for the form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The signer of the Form Field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `x` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The horizontal offset in pixels for this form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `y` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The vertical offset in pixels for this form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `width` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The width in pixels of this form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `height` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The height in pixels of this form field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean showing whether or not this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | | | +| `api_id` | ```string``` | A unique id for the form field. | | +| `name` | ```string``` | The name of the form field. | | +| `signer` | ```string``` | The signer of the Form Field. | | +| `x` | ```int``` | The horizontal offset in pixels for this form field. | | +| `y` | ```int``` | The vertical offset in pixels for this form field. | | +| `width` | ```int``` | The width in pixels of this form field. | | +| `height` | ```int``` | The height in pixels of this form field. | | +| `required` | ```bool``` | Boolean showing whether or not this field is required. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md index 849256a35..2ee1b9e5e 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md @@ -1,21 +1,12 @@ # # TemplateResponseDocumentFormFieldCheckbox -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentFormFieldText` -* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentFormFieldRadio` -* Signature Field uses `TemplateResponseDocumentFormFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | -| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md index 491aff76a..8996ce7a3 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md @@ -1,21 +1,12 @@ # # TemplateResponseDocumentFormFieldDateSigned -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentFormFieldText` -* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentFormFieldRadio` -* Signature Field uses `TemplateResponseDocumentFormFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'date_signed'] | -| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md index f81d66b9a..35cadabb5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md @@ -1,21 +1,12 @@ # # TemplateResponseDocumentFormFieldDropdown -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentFormFieldText` -* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentFormFieldRadio` -* Signature Field uses `TemplateResponseDocumentFormFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'dropdown'] | -| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md index 5cdfb577c..ce0ff23b5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md @@ -1,25 +1,16 @@ # # TemplateResponseDocumentFormFieldHyperlink -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentFormFieldText` -* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentFormFieldRadio` -* Signature Field uses `TemplateResponseDocumentFormFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'hyperlink'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_multiline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this form field is multiline text. REPLACE_ME_WITH_DESCRIPTION_END | | -| `original_font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Original font size used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | -| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | +| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size` | ```int``` | Original font size used in this form field's text. | | +| `font_family` | ```string``` | Font family used in this form field's text. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md index c8263854f..ab0ccda06 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md @@ -1,21 +1,12 @@ # # TemplateResponseDocumentFormFieldInitials -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentFormFieldText` -* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentFormFieldRadio` -* Signature Field uses `TemplateResponseDocumentFormFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'initials'] | -| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md index f30ded2a7..3b888caf7 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md @@ -1,21 +1,12 @@ # # TemplateResponseDocumentFormFieldRadio -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentFormFieldText` -* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentFormFieldRadio` -* Signature Field uses `TemplateResponseDocumentFormFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'radio'] | -| `group`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | +| `group`*_required_ | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md index 052cf942f..b46f1d963 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md @@ -1,21 +1,12 @@ # # TemplateResponseDocumentFormFieldSignature -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentFormFieldText` -* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentFormFieldRadio` -* Signature Field uses `TemplateResponseDocumentFormFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'signature'] | -| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md index 034b62ee6..e6af0e041 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md @@ -1,26 +1,17 @@ # # TemplateResponseDocumentFormFieldText -This class extends `TemplateResponseDocumentFormFieldBase` +This class extends `TemplateResponseDocumentFormFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this form field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentFormFieldText` -* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentFormFieldRadio` -* Signature Field uses `TemplateResponseDocumentFormFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentFormFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_multiline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this form field is multiline text. REPLACE_ME_WITH_DESCRIPTION_END | | -| `original_font_size` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Original font size used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | -| `font_family` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Font family used in this form field's text. REPLACE_ME_WITH_DESCRIPTION_END | | -| `validation_type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. REPLACE_ME_WITH_DESCRIPTION_END | | -| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | +| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size` | ```int``` | Original font size used in this form field's text. | | +| `font_family` | ```string``` | Font family used in this form field's text. | | +| `validation_type` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md index e97fcf9b5..3a7a044a4 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md @@ -6,15 +6,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `api_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN A unique id for the static field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the static field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signer` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The signer of the Static Field. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'me_now'] | -| `x` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The horizontal offset in pixels for this static field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `y` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The vertical offset in pixels for this static field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `width` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The width in pixels of this static field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `height` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The height in pixels of this static field. REPLACE_ME_WITH_DESCRIPTION_END | | -| `required` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Boolean showing whether or not this field is required. REPLACE_ME_WITH_DESCRIPTION_END | | -| `group` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the group this field is in. If this field is not a group, this defaults to `null`. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | | | +| `api_id` | ```string``` | A unique id for the static field. | | +| `name` | ```string``` | The name of the static field. | | +| `signer` | ```string``` | The signer of the Static Field. | [default to 'me_now'] | +| `x` | ```int``` | The horizontal offset in pixels for this static field. | | +| `y` | ```int``` | The vertical offset in pixels for this static field. | | +| `width` | ```int``` | The width in pixels of this static field. | | +| `height` | ```int``` | The height in pixels of this static field. | | +| `required` | ```bool``` | Boolean showing whether or not this field is required. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md index 6f430bc1d..4a23cb66b 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md @@ -1,20 +1,11 @@ # # TemplateResponseDocumentStaticFieldCheckbox -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentStaticFieldText` -* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` -* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'checkbox'] | +| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'checkbox'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md index 7e58405f4..9c9d86fb4 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md @@ -1,20 +1,11 @@ # # TemplateResponseDocumentStaticFieldDateSigned -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentStaticFieldText` -* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` -* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'date_signed'] | +| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'date_signed'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md index 4dbdedbd9..d5cdc36da 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md @@ -1,20 +1,11 @@ # # TemplateResponseDocumentStaticFieldDropdown -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentStaticFieldText` -* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` -* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'dropdown'] | +| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'dropdown'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md index af2745fea..304d2e082 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md @@ -1,20 +1,11 @@ # # TemplateResponseDocumentStaticFieldHyperlink -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentStaticFieldText` -* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` -* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'hyperlink'] | +| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'hyperlink'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md index a0f2f5ba2..9f112d1f3 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md @@ -1,20 +1,11 @@ # # TemplateResponseDocumentStaticFieldInitials -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentStaticFieldText` -* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` -* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'initials'] | +| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'initials'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md index 61b0135d9..1225138aa 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md @@ -1,20 +1,11 @@ # # TemplateResponseDocumentStaticFieldRadio -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentStaticFieldText` -* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` -* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'radio'] | +| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'radio'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md index d1b491e89..661b84cfd 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md @@ -1,20 +1,11 @@ # # TemplateResponseDocumentStaticFieldSignature -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentStaticFieldText` -* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` -* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'signature'] | +| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'signature'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md index 0bf726f51..fa528fb68 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md @@ -1,20 +1,11 @@ # # TemplateResponseDocumentStaticFieldText -This class extends `TemplateResponseDocumentStaticFieldBase` +This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of this static field. See [field types](/api/reference/constants/#field-types). - -* Text Field uses `TemplateResponseDocumentStaticFieldText` -* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` -* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` -* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` -* Radio Field uses `TemplateResponseDocumentStaticFieldRadio` -* Signature Field uses `TemplateResponseDocumentStaticFieldSignature` -* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` -* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` REPLACE_ME_WITH_DESCRIPTION_END | [default to 'text'] | +| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'text'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md index 5d97074e4..b9db83c57 100644 --- a/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md +++ b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md @@ -6,7 +6,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_lines` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of lines. REPLACE_ME_WITH_DESCRIPTION_END | | -| `num_chars_per_line` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Number of characters per line. REPLACE_ME_WITH_DESCRIPTION_END | | +| `num_lines` | ```int``` | Number of lines. | | +| `num_chars_per_line` | ```int``` | Number of characters per line. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseSignerRole.md b/sdks/php/docs/Model/TemplateResponseSignerRole.md index 9f4346a43..fdf2f15d0 100644 --- a/sdks/php/docs/Model/TemplateResponseSignerRole.md +++ b/sdks/php/docs/Model/TemplateResponseSignerRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The name of the Role. REPLACE_ME_WITH_DESCRIPTION_END | | -| `order` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN If signer order is assigned this is the 0-based index for this role. REPLACE_ME_WITH_DESCRIPTION_END | | +| `name` | ```string``` | The name of the Role. | | +| `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateUpdateFilesRequest.md b/sdks/php/docs/Model/TemplateUpdateFilesRequest.md index c0054585a..322110dd6 100644 --- a/sdks/php/docs/Model/TemplateUpdateFilesRequest.md +++ b/sdks/php/docs/Model/TemplateUpdateFilesRequest.md @@ -6,15 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app you're using to update this template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to use for the template. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The new default template email message. REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The new default template email subject. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `client_id` | ```string``` | Client id of the app you're using to update this template. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to use for the template.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```string``` | The new default template email message. | | +| `subject` | ```string``` | The new default template email subject. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateUpdateFilesResponse.md b/sdks/php/docs/Model/TemplateUpdateFilesResponse.md index 625f05899..5d28cef0d 100644 --- a/sdks/php/docs/Model/TemplateUpdateFilesResponse.md +++ b/sdks/php/docs/Model/TemplateUpdateFilesResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate```](TemplateUpdateFilesResponseTemplate.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | +| `template`*_required_ | [```\Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate```](TemplateUpdateFilesResponseTemplate.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md index 241a18a0f..b8fb3f5c2 100644 --- a/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md @@ -6,7 +6,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The id of the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `template_id` | ```string``` | The id of the Template. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md index 35c7ca139..4d9b2c5c4 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md @@ -6,73 +6,41 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `requester_email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_ccs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | -| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. - -**NOTE:** Only available for Premium plan and higher. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | -| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email addresses that should be CCed. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. - -Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. - -For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `force_signer_page` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the signers. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `force_subject_message` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the subject and message. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) - -**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. - -* Text Field use `SubFormFieldsPerDocumentText` -* Dropdown Field use `SubFormFieldsPerDocumentDropdown` -* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` -* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` -* Radio Field use `SubFormFieldsPerDocumentRadio` -* Signature Field use `SubFormFieldsPerDocumentSignature` -* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` -* Initials Field use `SubFormFieldsPerDocumentInitials` -* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` -* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | -| `hide_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `hold_request` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `is_for_embedded_signing` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `requesting_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully request a signature. REPLACE_ME_WITH_DESCRIPTION_END | | -| `show_preview` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the editor/preview experience. - -- `show_preview=true`: Allows requesters to enable the editor/preview experience. -- `show_preview=false`: Allows requesters to disable the editor/preview experience. REPLACE_ME_WITH_DESCRIPTION_END | | -| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | -| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Unclaimed Draft Signature Request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `skip_me_now` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `type` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. REPLACE_ME_WITH_DESCRIPTION_END | [default to 'request_signature'] | -| `use_preexisting_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `use_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `populate_auto_fill_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. - -**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. - -**NOTE:** This does not correspond to the **expires_at** returned in the response. REPLACE_ME_WITH_DESCRIPTION_END | | +| `client_id`*_required_ | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | +| `requester_email_address`*_required_ | ```string``` | The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to true] | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | +| `force_signer_page` | ```bool``` | Provide users the ability to review/edit the signers. | [default to false] | +| `force_subject_message` | ```bool``` | Provide users the ability to review/edit the subject and message. | [default to false] | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] | +| `hold_request` | ```bool``` | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] | +| `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature. | | +| `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | +| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | +| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `skip_me_now` | ```bool``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `type` | ```string``` | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [default to 'request_signature'] | +| `use_preexisting_fields` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | +| `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | +| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index 3b4cffb04..1d09deee9 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -6,53 +6,35 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `requester_email_address`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the user that should be designated as the requester of this draft. REPLACE_ME_WITH_DESCRIPTION_END | | -| `template_ids`*_required_ | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `allow_reassign` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. - -**NOTE:** Only available for Premium plan and higher. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add CC email recipients. Required when a CC role exists for the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN An array defining values and options for custom fields. Required when a custom field exists in the Template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. - -**files** or **file_urls[]** is required, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored. - -**files** or **file_urls[]** is required, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `force_signer_roles` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template signer roles. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `force_subject_message` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Provide users the ability to review/edit the template subject and message. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `hold_request` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `is_for_embedded_signing` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `preview_only` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). - -- `preview_only=true`: Allows requesters to enable the preview only experience. -- `preview_only=false`: Allows requesters to disable the preview only experience. - -**NOTE:** This parameter overwrites `show_preview=1` (if set). REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `requesting_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully request a signature. REPLACE_ME_WITH_DESCRIPTION_END | | -| `show_preview` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to enable the editor/preview experience. - -- `show_preview=true`: Allows requesters to enable the editor/preview experience. -- `show_preview=false`: Allows requesters to disable the editor/preview experience. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | -| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner[]```](SubUnclaimedDraftTemplateSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Templated-based Signature Request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `skip_me_now` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `title` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The title you want to assign to the SignatureRequest. REPLACE_ME_WITH_DESCRIPTION_END | | -| `populate_auto_fill_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. - -**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `allow_ccs` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `client_id`*_required_ | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | +| `requester_email_address`*_required_ | ```string``` | The email address of the user that should be designated as the requester of this draft. | | +| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored.

**files** or **file_urls[]** is required, but not both. | | +| `file_urls` | ```string[]``` | Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored.

**files** or **file_urls[]** is required, but not both. | | +| `force_signer_roles` | ```bool``` | Provide users the ability to review/edit the template signer roles. | [default to false] | +| `force_subject_message` | ```bool``` | Provide users the ability to review/edit the template subject and message. | [default to false] | +| `hold_request` | ```bool``` | The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] | +| `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `preview_only` | ```bool``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.

**NOTE:** This parameter overwrites `show_preview=1` (if set). | [default to false] | +| `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature. | | +| `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] | +| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | +| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner[]```](SubUnclaimedDraftTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `skip_me_now` | ```bool``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md index cc149fca8..afcb4a779 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md @@ -6,54 +6,29 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. REPLACE_ME_WITH_DESCRIPTION_END | | -| `files` | ```\SplFileObject[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `files[]` to indicate the uploaded file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `file_urls` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. - -This endpoint requires either **files** or **file_urls[]**, but not both. REPLACE_ME_WITH_DESCRIPTION_END | | -| `allow_decline` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Allows signers to decline to sign a document if `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list describing the attachments REPLACE_ME_WITH_DESCRIPTION_END | | -| `cc_email_addresses` | ```string[]``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email addresses that should be CCed. REPLACE_ME_WITH_DESCRIPTION_END | | -| `client_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. - -Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. - -For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. REPLACE_ME_WITH_DESCRIPTION_END | | -| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Conditional Logic rules for fields defined in `form_fields_per_document`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) - -**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. - -* Text Field use `SubFormFieldsPerDocumentText` -* Dropdown Field use `SubFormFieldsPerDocumentDropdown` -* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` -* Checkbox Field use `SubFormFieldsPerDocumentCheckbox` -* Radio Field use `SubFormFieldsPerDocumentRadio` -* Signature Field use `SubFormFieldsPerDocumentSignature` -* Date Signed Field use `SubFormFieldsPerDocumentDateSigned` -* Initials Field use `SubFormFieldsPerDocumentInitials` -* Text Merge Field use `SubFormFieldsPerDocumentTextMerge` -* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` REPLACE_ME_WITH_DESCRIPTION_END | | -| `hide_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `message` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The custom message in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `metadata` | ```array``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - -Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. REPLACE_ME_WITH_DESCRIPTION_END | | -| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | -| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN Add Signers to your Unclaimed Draft Signature Request. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `subject` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The subject in the email that will be sent to the signers. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `use_preexisting_fields` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `use_text_tags` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. - -**NOTE:** This does not correspond to the **expires_at** returned in the response. REPLACE_ME_WITH_DESCRIPTION_END | | +| `type`*_required_ | ```string``` | The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | +| `client_id` | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | +| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `use_preexisting_fields` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | +| `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | +| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md b/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md index 1d9e70ded..666b4ae1f 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `unclaimed_draft`*_required_ | [```\Dropbox\Sign\Model\UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN A list of warnings. REPLACE_ME_WITH_DESCRIPTION_END | | +| `unclaimed_draft`*_required_ | [```\Dropbox\Sign\Model\UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftEditAndResendRequest.md b/sdks/php/docs/Model/UnclaimedDraftEditAndResendRequest.md index a1809b54d..2ff47860e 100644 --- a/sdks/php/docs/Model/UnclaimedDraftEditAndResendRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftEditAndResendRequest.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. REPLACE_ME_WITH_DESCRIPTION_END | | -| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | REPLACE_ME_WITH_DESCRIPTION_BEGIN REPLACE_ME_WITH_DESCRIPTION_END | | -| `is_for_embedded_signing` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The request created from this draft will also be signable in embedded mode if set to `true`. REPLACE_ME_WITH_DESCRIPTION_END | | -| `requester_email_address` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The email address of the user that should be designated as the requester of this draft. If not set, original requester's email address will be used. REPLACE_ME_WITH_DESCRIPTION_END | | -| `requesting_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully request a signature. REPLACE_ME_WITH_DESCRIPTION_END | | -| `show_progress_stepper` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. REPLACE_ME_WITH_DESCRIPTION_END | [default to true] | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. REPLACE_ME_WITH_DESCRIPTION_END | [default to false] | +| `client_id`*_required_ | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | +| `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | +| `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. | | +| `requester_email_address` | ```string``` | The email address of the user that should be designated as the requester of this draft. If not set, original requester's email address will be used. | | +| `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature. | | +| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftResponse.md b/sdks/php/docs/Model/UnclaimedDraftResponse.md index 2ec9a74e2..36989223b 100644 --- a/sdks/php/docs/Model/UnclaimedDraftResponse.md +++ b/sdks/php/docs/Model/UnclaimedDraftResponse.md @@ -6,11 +6,11 @@ A group of documents that a user can take ownership of via the claim URL. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_request_id` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The ID of the signature request that is represented by this UnclaimedDraft. REPLACE_ME_WITH_DESCRIPTION_END | | -| `claim_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL to be used to claim this UnclaimedDraft. REPLACE_ME_WITH_DESCRIPTION_END | | -| `signing_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully sign. REPLACE_ME_WITH_DESCRIPTION_END | | -| `requesting_redirect_url` | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). REPLACE_ME_WITH_DESCRIPTION_END | | -| `expires_at` | ```int``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN When the link expires. REPLACE_ME_WITH_DESCRIPTION_END | | -| `test_mode` | ```bool``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Whether this is a test draft. Signature requests made from test drafts have no legal value. REPLACE_ME_WITH_DESCRIPTION_END | | +| `signature_request_id` | ```string``` | The ID of the signature request that is represented by this UnclaimedDraft. | | +| `claim_url` | ```string``` | The URL to be used to claim this UnclaimedDraft. | | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). | | +| `expires_at` | ```int``` | When the link expires. | | +| `test_mode` | ```bool``` | Whether this is a test draft. Signature requests made from test drafts have no legal value. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/WarningResponse.md b/sdks/php/docs/Model/WarningResponse.md index 869c23786..8bec8a324 100644 --- a/sdks/php/docs/Model/WarningResponse.md +++ b/sdks/php/docs/Model/WarningResponse.md @@ -6,7 +6,7 @@ A list of warnings. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `warning_msg`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Warning message REPLACE_ME_WITH_DESCRIPTION_END | | -| `warning_name`*_required_ | ```string``` | REPLACE_ME_WITH_DESCRIPTION_BEGIN Warning name REPLACE_ME_WITH_DESCRIPTION_END | | +| `warning_msg`*_required_ | ```string``` | Warning message | | +| `warning_name`*_required_ | ```string``` | Warning name | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/src/Api/AccountApi.php b/sdks/php/src/Api/AccountApi.php index c3a6717a1..cfdc96f11 100644 --- a/sdks/php/src/Api/AccountApi.php +++ b/sdks/php/src/Api/AccountApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,34 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; /** * AccountApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class AccountApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'accountCreate' => [ 'application/json', @@ -92,16 +85,13 @@ class AccountApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -115,7 +105,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -152,13 +142,13 @@ public function getResponse() * * Create Account * - * @param \Dropbox\Sign\Model\AccountCreateRequest $account_create_request account_create_request (required) + * @param Model\AccountCreateRequest $account_create_request account_create_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\AccountCreateResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\AccountCreateResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function accountCreate($account_create_request) + public function accountCreate(Model\AccountCreateRequest $account_create_request) { list($response) = $this->accountCreateWithHttpInfo($account_create_request); return $response; @@ -169,15 +159,15 @@ public function accountCreate($account_create_request) * * Create Account * - * @param \Dropbox\Sign\Model\AccountCreateRequest $account_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation + * @param Model\AccountCreateRequest $account_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\AccountCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\AccountCreateResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountCreate. This method will eventually become unavailable */ - public function accountCreateWithHttpInfo($account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) + public function accountCreateWithHttpInfo(Model\AccountCreateRequest $account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) { $request = $this->accountCreateRequest($account_create_request, $contentType); @@ -189,14 +179,14 @@ public function accountCreateWithHttpInfo($account_create_request, string $conte } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -209,14 +199,14 @@ public function accountCreateWithHttpInfo($account_create_request, string $conte sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -225,18 +215,17 @@ public function accountCreateWithHttpInfo($account_create_request, string $conte if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\AccountCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\AccountCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -253,20 +242,19 @@ public function accountCreateWithHttpInfo($account_create_request, string $conte return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\AccountCreateResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\AccountCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -283,11 +271,9 @@ public function accountCreateWithHttpInfo($account_create_request, string $conte return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -300,7 +286,6 @@ public function accountCreateWithHttpInfo($account_create_request, string $conte ); $e->setResponseObject($data); break; - } throw $e; } @@ -311,14 +296,14 @@ public function accountCreateWithHttpInfo($account_create_request, string $conte * * Create Account * - * @param \Dropbox\Sign\Model\AccountCreateRequest $account_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation + * @param Model\AccountCreateRequest $account_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountCreate. This method will eventually become unavailable */ - public function accountCreateAsync($account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) + public function accountCreateAsync(Model\AccountCreateRequest $account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) { return $this->accountCreateAsyncWithHttpInfo($account_create_request, $contentType) ->then( @@ -333,14 +318,14 @@ function ($response) { * * Create Account * - * @param \Dropbox\Sign\Model\AccountCreateRequest $account_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation + * @param Model\AccountCreateRequest $account_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountCreate. This method will eventually become unavailable */ - public function accountCreateAsyncWithHttpInfo($account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) + public function accountCreateAsyncWithHttpInfo(Model\AccountCreateRequest $account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) { $returnType = '\Dropbox\Sign\Model\AccountCreateResponse'; $request = $this->accountCreateRequest($account_create_request, $contentType); @@ -350,9 +335,9 @@ public function accountCreateAsyncWithHttpInfo($account_create_request, string $ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -361,7 +346,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -375,7 +360,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -384,24 +369,22 @@ function ($exception) { /** * Create request for operation 'accountCreate' * - * @param \Dropbox\Sign\Model\AccountCreateRequest $account_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation + * @param Model\AccountCreateRequest $account_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountCreate. This method will eventually become unavailable */ - public function accountCreateRequest($account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) + public function accountCreateRequest(Model\AccountCreateRequest $account_create_request, string $contentType = self::contentTypes['accountCreate'][0]) { - // verify the required parameter 'account_create_request' is set if ($account_create_request === null || (is_array($account_create_request) && count($account_create_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $account_create_request when calling accountCreate' ); } - $resourcePath = '/account/create'; $formParams = []; $queryParams = []; @@ -415,11 +398,8 @@ public function accountCreateRequest($account_create_request, string $contentTyp $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -427,7 +407,7 @@ public function accountCreateRequest($account_create_request, string $contentTyp // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($account_create_request)); } else { $httpBody = $account_create_request; @@ -440,7 +420,7 @@ public function accountCreateRequest($account_create_request, string $contentTyp foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -457,9 +437,8 @@ public function accountCreateRequest($account_create_request, string $contentTyp $payloadHook('multipart', $multipartContents, $account_create_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -502,14 +481,14 @@ public function accountCreateRequest($account_create_request, string $contentTyp * * Get Account * - * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) - * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) + * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) + * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\AccountGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\AccountGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function accountGet($account_id = null, $email_address = null) + public function accountGet(string $account_id = null, string $email_address = null) { list($response) = $this->accountGetWithHttpInfo($account_id, $email_address); return $response; @@ -520,16 +499,16 @@ public function accountGet($account_id = null, $email_address = null) * * Get Account * - * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) - * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation + * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) + * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\AccountGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\AccountGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountGet. This method will eventually become unavailable */ - public function accountGetWithHttpInfo($account_id = null, $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) + public function accountGetWithHttpInfo(string $account_id = null, string $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) { $request = $this->accountGetRequest($account_id, $email_address, $contentType); @@ -541,14 +520,14 @@ public function accountGetWithHttpInfo($account_id = null, $email_address = null } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -561,14 +540,14 @@ public function accountGetWithHttpInfo($account_id = null, $email_address = null sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -577,18 +556,17 @@ public function accountGetWithHttpInfo($account_id = null, $email_address = null if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\AccountGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\AccountGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -605,20 +583,19 @@ public function accountGetWithHttpInfo($account_id = null, $email_address = null return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\AccountGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\AccountGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -635,11 +612,9 @@ public function accountGetWithHttpInfo($account_id = null, $email_address = null return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -652,7 +627,6 @@ public function accountGetWithHttpInfo($account_id = null, $email_address = null ); $e->setResponseObject($data); break; - } throw $e; } @@ -663,15 +637,15 @@ public function accountGetWithHttpInfo($account_id = null, $email_address = null * * Get Account * - * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) - * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation + * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) + * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountGet. This method will eventually become unavailable */ - public function accountGetAsync($account_id = null, $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) + public function accountGetAsync(string $account_id = null, string $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) { return $this->accountGetAsyncWithHttpInfo($account_id, $email_address, $contentType) ->then( @@ -686,15 +660,15 @@ function ($response) { * * Get Account * - * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) - * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation + * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) + * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountGet. This method will eventually become unavailable */ - public function accountGetAsyncWithHttpInfo($account_id = null, $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) + public function accountGetAsyncWithHttpInfo(string $account_id = null, string $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) { $returnType = '\Dropbox\Sign\Model\AccountGetResponse'; $request = $this->accountGetRequest($account_id, $email_address, $contentType); @@ -704,9 +678,9 @@ public function accountGetAsyncWithHttpInfo($account_id = null, $email_address = ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -715,7 +689,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -729,7 +703,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -738,20 +712,16 @@ function ($exception) { /** * Create request for operation 'accountGet' * - * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) - * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation + * @param string $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) + * @param string $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountGet. This method will eventually become unavailable */ - public function accountGetRequest($account_id = null, $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) + public function accountGetRequest(string $account_id = null, string $email_address = null, string $contentType = self::contentTypes['accountGet'][0]) { - - - - $resourcePath = '/account'; $formParams = []; $queryParams = []; @@ -778,11 +748,8 @@ public function accountGetRequest($account_id = null, $email_address = null, str false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -796,7 +763,7 @@ public function accountGetRequest($account_id = null, $email_address = null, str foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -810,9 +777,8 @@ public function accountGetRequest($account_id = null, $email_address = null, str } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -855,13 +821,13 @@ public function accountGetRequest($account_id = null, $email_address = null, str * * Update Account * - * @param \Dropbox\Sign\Model\AccountUpdateRequest $account_update_request account_update_request (required) + * @param Model\AccountUpdateRequest $account_update_request account_update_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\AccountGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\AccountGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function accountUpdate($account_update_request) + public function accountUpdate(Model\AccountUpdateRequest $account_update_request) { list($response) = $this->accountUpdateWithHttpInfo($account_update_request); return $response; @@ -872,15 +838,15 @@ public function accountUpdate($account_update_request) * * Update Account * - * @param \Dropbox\Sign\Model\AccountUpdateRequest $account_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation + * @param Model\AccountUpdateRequest $account_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\AccountGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\AccountGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountUpdate. This method will eventually become unavailable */ - public function accountUpdateWithHttpInfo($account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) + public function accountUpdateWithHttpInfo(Model\AccountUpdateRequest $account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) { $request = $this->accountUpdateRequest($account_update_request, $contentType); @@ -892,14 +858,14 @@ public function accountUpdateWithHttpInfo($account_update_request, string $conte } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -912,14 +878,14 @@ public function accountUpdateWithHttpInfo($account_update_request, string $conte sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -928,18 +894,17 @@ public function accountUpdateWithHttpInfo($account_update_request, string $conte if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\AccountGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\AccountGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -956,20 +921,19 @@ public function accountUpdateWithHttpInfo($account_update_request, string $conte return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\AccountGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\AccountGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -986,11 +950,9 @@ public function accountUpdateWithHttpInfo($account_update_request, string $conte return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1003,7 +965,6 @@ public function accountUpdateWithHttpInfo($account_update_request, string $conte ); $e->setResponseObject($data); break; - } throw $e; } @@ -1014,14 +975,14 @@ public function accountUpdateWithHttpInfo($account_update_request, string $conte * * Update Account * - * @param \Dropbox\Sign\Model\AccountUpdateRequest $account_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation + * @param Model\AccountUpdateRequest $account_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountUpdate. This method will eventually become unavailable */ - public function accountUpdateAsync($account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) + public function accountUpdateAsync(Model\AccountUpdateRequest $account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) { return $this->accountUpdateAsyncWithHttpInfo($account_update_request, $contentType) ->then( @@ -1036,14 +997,14 @@ function ($response) { * * Update Account * - * @param \Dropbox\Sign\Model\AccountUpdateRequest $account_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation + * @param Model\AccountUpdateRequest $account_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountUpdate. This method will eventually become unavailable */ - public function accountUpdateAsyncWithHttpInfo($account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) + public function accountUpdateAsyncWithHttpInfo(Model\AccountUpdateRequest $account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) { $returnType = '\Dropbox\Sign\Model\AccountGetResponse'; $request = $this->accountUpdateRequest($account_update_request, $contentType); @@ -1053,9 +1014,9 @@ public function accountUpdateAsyncWithHttpInfo($account_update_request, string $ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1064,7 +1025,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1078,7 +1039,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1087,24 +1048,22 @@ function ($exception) { /** * Create request for operation 'accountUpdate' * - * @param \Dropbox\Sign\Model\AccountUpdateRequest $account_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation + * @param Model\AccountUpdateRequest $account_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountUpdate. This method will eventually become unavailable */ - public function accountUpdateRequest($account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) + public function accountUpdateRequest(Model\AccountUpdateRequest $account_update_request, string $contentType = self::contentTypes['accountUpdate'][0]) { - // verify the required parameter 'account_update_request' is set if ($account_update_request === null || (is_array($account_update_request) && count($account_update_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $account_update_request when calling accountUpdate' ); } - $resourcePath = '/account'; $formParams = []; $queryParams = []; @@ -1118,11 +1077,8 @@ public function accountUpdateRequest($account_update_request, string $contentTyp $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1130,7 +1086,7 @@ public function accountUpdateRequest($account_update_request, string $contentTyp // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($account_update_request)); } else { $httpBody = $account_update_request; @@ -1143,7 +1099,7 @@ public function accountUpdateRequest($account_update_request, string $contentTyp foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1160,9 +1116,8 @@ public function accountUpdateRequest($account_update_request, string $contentTyp $payloadHook('multipart', $multipartContents, $account_update_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1205,13 +1160,13 @@ public function accountUpdateRequest($account_update_request, string $contentTyp * * Verify Account * - * @param \Dropbox\Sign\Model\AccountVerifyRequest $account_verify_request account_verify_request (required) + * @param Model\AccountVerifyRequest $account_verify_request account_verify_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\AccountVerifyResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\AccountVerifyResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function accountVerify($account_verify_request) + public function accountVerify(Model\AccountVerifyRequest $account_verify_request) { list($response) = $this->accountVerifyWithHttpInfo($account_verify_request); return $response; @@ -1222,15 +1177,15 @@ public function accountVerify($account_verify_request) * * Verify Account * - * @param \Dropbox\Sign\Model\AccountVerifyRequest $account_verify_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation + * @param Model\AccountVerifyRequest $account_verify_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\AccountVerifyResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\AccountVerifyResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountVerify. This method will eventually become unavailable */ - public function accountVerifyWithHttpInfo($account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) + public function accountVerifyWithHttpInfo(Model\AccountVerifyRequest $account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) { $request = $this->accountVerifyRequest($account_verify_request, $contentType); @@ -1242,14 +1197,14 @@ public function accountVerifyWithHttpInfo($account_verify_request, string $conte } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1262,14 +1217,14 @@ public function accountVerifyWithHttpInfo($account_verify_request, string $conte sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1278,18 +1233,17 @@ public function accountVerifyWithHttpInfo($account_verify_request, string $conte if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\AccountVerifyResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\AccountVerifyResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1306,20 +1260,19 @@ public function accountVerifyWithHttpInfo($account_verify_request, string $conte return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\AccountVerifyResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\AccountVerifyResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1336,11 +1289,9 @@ public function accountVerifyWithHttpInfo($account_verify_request, string $conte return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1353,7 +1304,6 @@ public function accountVerifyWithHttpInfo($account_verify_request, string $conte ); $e->setResponseObject($data); break; - } throw $e; } @@ -1364,14 +1314,14 @@ public function accountVerifyWithHttpInfo($account_verify_request, string $conte * * Verify Account * - * @param \Dropbox\Sign\Model\AccountVerifyRequest $account_verify_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation + * @param Model\AccountVerifyRequest $account_verify_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountVerify. This method will eventually become unavailable */ - public function accountVerifyAsync($account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) + public function accountVerifyAsync(Model\AccountVerifyRequest $account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) { return $this->accountVerifyAsyncWithHttpInfo($account_verify_request, $contentType) ->then( @@ -1386,14 +1336,14 @@ function ($response) { * * Verify Account * - * @param \Dropbox\Sign\Model\AccountVerifyRequest $account_verify_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation + * @param Model\AccountVerifyRequest $account_verify_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountVerify. This method will eventually become unavailable */ - public function accountVerifyAsyncWithHttpInfo($account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) + public function accountVerifyAsyncWithHttpInfo(Model\AccountVerifyRequest $account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) { $returnType = '\Dropbox\Sign\Model\AccountVerifyResponse'; $request = $this->accountVerifyRequest($account_verify_request, $contentType); @@ -1403,9 +1353,9 @@ public function accountVerifyAsyncWithHttpInfo($account_verify_request, string $ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1414,7 +1364,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1428,7 +1378,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1437,24 +1387,22 @@ function ($exception) { /** * Create request for operation 'accountVerify' * - * @param \Dropbox\Sign\Model\AccountVerifyRequest $account_verify_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation + * @param Model\AccountVerifyRequest $account_verify_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::accountVerify. This method will eventually become unavailable */ - public function accountVerifyRequest($account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) + public function accountVerifyRequest(Model\AccountVerifyRequest $account_verify_request, string $contentType = self::contentTypes['accountVerify'][0]) { - // verify the required parameter 'account_verify_request' is set if ($account_verify_request === null || (is_array($account_verify_request) && count($account_verify_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $account_verify_request when calling accountVerify' ); } - $resourcePath = '/account/verify'; $formParams = []; $queryParams = []; @@ -1468,11 +1416,8 @@ public function accountVerifyRequest($account_verify_request, string $contentTyp $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1480,7 +1425,7 @@ public function accountVerifyRequest($account_verify_request, string $contentTyp // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($account_verify_request)); } else { $httpBody = $account_verify_request; @@ -1493,7 +1438,7 @@ public function accountVerifyRequest($account_verify_request, string $contentTyp foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1510,9 +1455,8 @@ public function accountVerifyRequest($account_verify_request, string $contentTyp $payloadHook('multipart', $multipartContents, $account_verify_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1553,8 +1497,8 @@ public function accountVerifyRequest($account_verify_request, string $contentTyp /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -1562,7 +1506,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -1578,8 +1522,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -1589,9 +1533,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -1610,8 +1554,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/ApiAppApi.php b/sdks/php/src/Api/ApiAppApi.php index f9d35ad11..07dd3db63 100644 --- a/sdks/php/src/Api/ApiAppApi.php +++ b/sdks/php/src/Api/ApiAppApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,34 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; /** * ApiAppApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class ApiAppApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'apiAppCreate' => [ 'application/json', @@ -97,16 +90,13 @@ class ApiAppApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -120,7 +110,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -157,13 +147,13 @@ public function getResponse() * * Create API App * - * @param \Dropbox\Sign\Model\ApiAppCreateRequest $api_app_create_request api_app_create_request (required) + * @param Model\ApiAppCreateRequest $api_app_create_request api_app_create_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\ApiAppGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function apiAppCreate($api_app_create_request) + public function apiAppCreate(Model\ApiAppCreateRequest $api_app_create_request) { list($response) = $this->apiAppCreateWithHttpInfo($api_app_create_request); return $response; @@ -174,15 +164,15 @@ public function apiAppCreate($api_app_create_request) * * Create API App * - * @param \Dropbox\Sign\Model\ApiAppCreateRequest $api_app_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation + * @param Model\ApiAppCreateRequest $api_app_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\ApiAppGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppCreate. This method will eventually become unavailable */ - public function apiAppCreateWithHttpInfo($api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) + public function apiAppCreateWithHttpInfo(Model\ApiAppCreateRequest $api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) { $request = $this->apiAppCreateRequest($api_app_create_request, $contentType); @@ -194,14 +184,14 @@ public function apiAppCreateWithHttpInfo($api_app_create_request, string $conten } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -214,14 +204,14 @@ public function apiAppCreateWithHttpInfo($api_app_create_request, string $conten sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -230,18 +220,17 @@ public function apiAppCreateWithHttpInfo($api_app_create_request, string $conten if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 201: if ('\Dropbox\Sign\Model\ApiAppGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\ApiAppGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -258,20 +247,19 @@ public function apiAppCreateWithHttpInfo($api_app_create_request, string $conten return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\ApiAppGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -288,11 +276,9 @@ public function apiAppCreateWithHttpInfo($api_app_create_request, string $conten return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -305,7 +291,6 @@ public function apiAppCreateWithHttpInfo($api_app_create_request, string $conten ); $e->setResponseObject($data); break; - } throw $e; } @@ -316,14 +301,14 @@ public function apiAppCreateWithHttpInfo($api_app_create_request, string $conten * * Create API App * - * @param \Dropbox\Sign\Model\ApiAppCreateRequest $api_app_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation + * @param Model\ApiAppCreateRequest $api_app_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppCreate. This method will eventually become unavailable */ - public function apiAppCreateAsync($api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) + public function apiAppCreateAsync(Model\ApiAppCreateRequest $api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) { return $this->apiAppCreateAsyncWithHttpInfo($api_app_create_request, $contentType) ->then( @@ -338,14 +323,14 @@ function ($response) { * * Create API App * - * @param \Dropbox\Sign\Model\ApiAppCreateRequest $api_app_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation + * @param Model\ApiAppCreateRequest $api_app_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppCreate. This method will eventually become unavailable */ - public function apiAppCreateAsyncWithHttpInfo($api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) + public function apiAppCreateAsyncWithHttpInfo(Model\ApiAppCreateRequest $api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) { $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; $request = $this->apiAppCreateRequest($api_app_create_request, $contentType); @@ -355,9 +340,9 @@ public function apiAppCreateAsyncWithHttpInfo($api_app_create_request, string $c ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -366,7 +351,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -380,7 +365,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -389,24 +374,22 @@ function ($exception) { /** * Create request for operation 'apiAppCreate' * - * @param \Dropbox\Sign\Model\ApiAppCreateRequest $api_app_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation + * @param Model\ApiAppCreateRequest $api_app_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppCreate. This method will eventually become unavailable */ - public function apiAppCreateRequest($api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) + public function apiAppCreateRequest(Model\ApiAppCreateRequest $api_app_create_request, string $contentType = self::contentTypes['apiAppCreate'][0]) { - // verify the required parameter 'api_app_create_request' is set if ($api_app_create_request === null || (is_array($api_app_create_request) && count($api_app_create_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $api_app_create_request when calling apiAppCreate' ); } - $resourcePath = '/api_app'; $formParams = []; $queryParams = []; @@ -420,11 +403,8 @@ public function apiAppCreateRequest($api_app_create_request, string $contentType $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -432,7 +412,7 @@ public function apiAppCreateRequest($api_app_create_request, string $contentType // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($api_app_create_request)); } else { $httpBody = $api_app_create_request; @@ -445,7 +425,7 @@ public function apiAppCreateRequest($api_app_create_request, string $contentType foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -462,9 +442,8 @@ public function apiAppCreateRequest($api_app_create_request, string $contentType $payloadHook('multipart', $multipartContents, $api_app_create_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -507,13 +486,12 @@ public function apiAppCreateRequest($api_app_create_request, string $contentType * * Delete API App * - * @param string $client_id The client id of the API App to delete. (required) + * @param string $client_id The client id of the API App to delete. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return void + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function apiAppDelete($client_id) + public function apiAppDelete(string $client_id) { $this->apiAppDeleteWithHttpInfo($client_id); } @@ -523,15 +501,15 @@ public function apiAppDelete($client_id) * * Delete API App * - * @param string $client_id The client id of the API App to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation + * @param string $client_id The client id of the API App to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppDelete. This method will eventually become unavailable */ - public function apiAppDeleteWithHttpInfo($client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) + public function apiAppDeleteWithHttpInfo(string $client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) { $request = $this->apiAppDeleteRequest($client_id, $contentType); @@ -543,14 +521,14 @@ public function apiAppDeleteWithHttpInfo($client_id, string $contentType = self: } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -563,23 +541,20 @@ public function apiAppDeleteWithHttpInfo($client_id, string $contentType = self: sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { - } throw $e; } @@ -590,14 +565,14 @@ public function apiAppDeleteWithHttpInfo($client_id, string $contentType = self: * * Delete API App * - * @param string $client_id The client id of the API App to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation + * @param string $client_id The client id of the API App to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppDelete. This method will eventually become unavailable */ - public function apiAppDeleteAsync($client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) + public function apiAppDeleteAsync(string $client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) { return $this->apiAppDeleteAsyncWithHttpInfo($client_id, $contentType) ->then( @@ -612,14 +587,14 @@ function ($response) { * * Delete API App * - * @param string $client_id The client id of the API App to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation + * @param string $client_id The client id of the API App to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppDelete. This method will eventually become unavailable */ - public function apiAppDeleteAsyncWithHttpInfo($client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) + public function apiAppDeleteAsyncWithHttpInfo(string $client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) { $returnType = ''; $request = $this->apiAppDeleteRequest($client_id, $contentType); @@ -627,7 +602,7 @@ public function apiAppDeleteAsyncWithHttpInfo($client_id, string $contentType = return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) use ($returnType) { + function ($response) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -641,7 +616,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -650,24 +625,22 @@ function ($exception) { /** * Create request for operation 'apiAppDelete' * - * @param string $client_id The client id of the API App to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation + * @param string $client_id The client id of the API App to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppDelete. This method will eventually become unavailable */ - public function apiAppDeleteRequest($client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) + public function apiAppDeleteRequest(string $client_id, string $contentType = self::contentTypes['apiAppDelete'][0]) { - // verify the required parameter 'client_id' is set if ($client_id === null || (is_array($client_id) && count($client_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $client_id when calling apiAppDelete' ); } - $resourcePath = '/api_app/{client_id}'; $formParams = []; $queryParams = []; @@ -675,20 +648,17 @@ public function apiAppDeleteRequest($client_id, string $contentType = self::cont $httpBody = ''; $multipart = false; - - // path params if ($client_id !== null) { $resourcePath = str_replace( - '{' . 'client_id' . '}', + '{client_id}', ObjectSerializer::toPathValue($client_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -702,7 +672,7 @@ public function apiAppDeleteRequest($client_id, string $contentType = self::cont foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -716,9 +686,8 @@ public function apiAppDeleteRequest($client_id, string $contentType = self::cont } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -761,13 +730,13 @@ public function apiAppDeleteRequest($client_id, string $contentType = self::cont * * Get API App * - * @param string $client_id The client id of the API App to retrieve. (required) + * @param string $client_id The client id of the API App to retrieve. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\ApiAppGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function apiAppGet($client_id) + public function apiAppGet(string $client_id) { list($response) = $this->apiAppGetWithHttpInfo($client_id); return $response; @@ -778,15 +747,15 @@ public function apiAppGet($client_id) * * Get API App * - * @param string $client_id The client id of the API App to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation + * @param string $client_id The client id of the API App to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\ApiAppGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppGet. This method will eventually become unavailable */ - public function apiAppGetWithHttpInfo($client_id, string $contentType = self::contentTypes['apiAppGet'][0]) + public function apiAppGetWithHttpInfo(string $client_id, string $contentType = self::contentTypes['apiAppGet'][0]) { $request = $this->apiAppGetRequest($client_id, $contentType); @@ -798,14 +767,14 @@ public function apiAppGetWithHttpInfo($client_id, string $contentType = self::co } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -818,14 +787,14 @@ public function apiAppGetWithHttpInfo($client_id, string $contentType = self::co sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -834,18 +803,17 @@ public function apiAppGetWithHttpInfo($client_id, string $contentType = self::co if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\ApiAppGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\ApiAppGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -862,20 +830,19 @@ public function apiAppGetWithHttpInfo($client_id, string $contentType = self::co return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\ApiAppGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -892,11 +859,9 @@ public function apiAppGetWithHttpInfo($client_id, string $contentType = self::co return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -909,7 +874,6 @@ public function apiAppGetWithHttpInfo($client_id, string $contentType = self::co ); $e->setResponseObject($data); break; - } throw $e; } @@ -920,14 +884,14 @@ public function apiAppGetWithHttpInfo($client_id, string $contentType = self::co * * Get API App * - * @param string $client_id The client id of the API App to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation + * @param string $client_id The client id of the API App to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppGet. This method will eventually become unavailable */ - public function apiAppGetAsync($client_id, string $contentType = self::contentTypes['apiAppGet'][0]) + public function apiAppGetAsync(string $client_id, string $contentType = self::contentTypes['apiAppGet'][0]) { return $this->apiAppGetAsyncWithHttpInfo($client_id, $contentType) ->then( @@ -942,14 +906,14 @@ function ($response) { * * Get API App * - * @param string $client_id The client id of the API App to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation + * @param string $client_id The client id of the API App to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppGet. This method will eventually become unavailable */ - public function apiAppGetAsyncWithHttpInfo($client_id, string $contentType = self::contentTypes['apiAppGet'][0]) + public function apiAppGetAsyncWithHttpInfo(string $client_id, string $contentType = self::contentTypes['apiAppGet'][0]) { $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; $request = $this->apiAppGetRequest($client_id, $contentType); @@ -959,9 +923,9 @@ public function apiAppGetAsyncWithHttpInfo($client_id, string $contentType = sel ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -970,7 +934,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -984,7 +948,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -993,24 +957,22 @@ function ($exception) { /** * Create request for operation 'apiAppGet' * - * @param string $client_id The client id of the API App to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation + * @param string $client_id The client id of the API App to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppGet. This method will eventually become unavailable */ - public function apiAppGetRequest($client_id, string $contentType = self::contentTypes['apiAppGet'][0]) + public function apiAppGetRequest(string $client_id, string $contentType = self::contentTypes['apiAppGet'][0]) { - // verify the required parameter 'client_id' is set if ($client_id === null || (is_array($client_id) && count($client_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $client_id when calling apiAppGet' ); } - $resourcePath = '/api_app/{client_id}'; $formParams = []; $queryParams = []; @@ -1018,20 +980,17 @@ public function apiAppGetRequest($client_id, string $contentType = self::content $httpBody = ''; $multipart = false; - - // path params if ($client_id !== null) { $resourcePath = str_replace( - '{' . 'client_id' . '}', + '{client_id}', ObjectSerializer::toPathValue($client_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1045,7 +1004,7 @@ public function apiAppGetRequest($client_id, string $contentType = self::content foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1059,9 +1018,8 @@ public function apiAppGetRequest($client_id, string $contentType = self::content } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1104,14 +1062,14 @@ public function apiAppGetRequest($client_id, string $contentType = self::content * * List API Apps * - * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\ApiAppListResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\ApiAppListResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function apiAppList($page = 1, $page_size = 20) + public function apiAppList(int $page = 1, int $page_size = 20) { list($response) = $this->apiAppListWithHttpInfo($page, $page_size); return $response; @@ -1122,16 +1080,16 @@ public function apiAppList($page = 1, $page_size = 20) * * List API Apps * - * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation + * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\ApiAppListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\ApiAppListResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppList. This method will eventually become unavailable */ - public function apiAppListWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) + public function apiAppListWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) { $request = $this->apiAppListRequest($page, $page_size, $contentType); @@ -1143,14 +1101,14 @@ public function apiAppListWithHttpInfo($page = 1, $page_size = 20, string $conte } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1163,14 +1121,14 @@ public function apiAppListWithHttpInfo($page = 1, $page_size = 20, string $conte sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1179,18 +1137,17 @@ public function apiAppListWithHttpInfo($page = 1, $page_size = 20, string $conte if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\ApiAppListResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\ApiAppListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1207,20 +1164,19 @@ public function apiAppListWithHttpInfo($page = 1, $page_size = 20, string $conte return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\ApiAppListResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\ApiAppListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1237,11 +1193,9 @@ public function apiAppListWithHttpInfo($page = 1, $page_size = 20, string $conte return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1254,7 +1208,6 @@ public function apiAppListWithHttpInfo($page = 1, $page_size = 20, string $conte ); $e->setResponseObject($data); break; - } throw $e; } @@ -1265,15 +1218,15 @@ public function apiAppListWithHttpInfo($page = 1, $page_size = 20, string $conte * * List API Apps * - * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation + * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppList. This method will eventually become unavailable */ - public function apiAppListAsync($page = 1, $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) + public function apiAppListAsync(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) { return $this->apiAppListAsyncWithHttpInfo($page, $page_size, $contentType) ->then( @@ -1288,15 +1241,15 @@ function ($response) { * * List API Apps * - * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation + * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppList. This method will eventually become unavailable */ - public function apiAppListAsyncWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) + public function apiAppListAsyncWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) { $returnType = '\Dropbox\Sign\Model\ApiAppListResponse'; $request = $this->apiAppListRequest($page, $page_size, $contentType); @@ -1306,9 +1259,9 @@ public function apiAppListAsyncWithHttpInfo($page = 1, $page_size = 20, string $ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1317,7 +1270,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1331,7 +1284,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1340,20 +1293,16 @@ function ($exception) { /** * Create request for operation 'apiAppList' * - * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation + * @param int $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppList. This method will eventually become unavailable */ - public function apiAppListRequest($page = 1, $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) + public function apiAppListRequest(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['apiAppList'][0]) { - - - - $resourcePath = '/api_app/list'; $formParams = []; $queryParams = []; @@ -1380,11 +1329,8 @@ public function apiAppListRequest($page = 1, $page_size = 20, string $contentTyp false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1398,7 +1344,7 @@ public function apiAppListRequest($page = 1, $page_size = 20, string $contentTyp foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1412,9 +1358,8 @@ public function apiAppListRequest($page = 1, $page_size = 20, string $contentTyp } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1457,14 +1402,14 @@ public function apiAppListRequest($page = 1, $page_size = 20, string $contentTyp * * Update API App * - * @param string $client_id The client id of the API App to update. (required) - * @param \Dropbox\Sign\Model\ApiAppUpdateRequest $api_app_update_request api_app_update_request (required) + * @param string $client_id The client id of the API App to update. (required) + * @param Model\ApiAppUpdateRequest $api_app_update_request api_app_update_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\ApiAppGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function apiAppUpdate($client_id, $api_app_update_request) + public function apiAppUpdate(string $client_id, Model\ApiAppUpdateRequest $api_app_update_request) { list($response) = $this->apiAppUpdateWithHttpInfo($client_id, $api_app_update_request); return $response; @@ -1475,16 +1420,16 @@ public function apiAppUpdate($client_id, $api_app_update_request) * * Update API App * - * @param string $client_id The client id of the API App to update. (required) - * @param \Dropbox\Sign\Model\ApiAppUpdateRequest $api_app_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation + * @param string $client_id The client id of the API App to update. (required) + * @param Model\ApiAppUpdateRequest $api_app_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\ApiAppGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\ApiAppGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppUpdate. This method will eventually become unavailable */ - public function apiAppUpdateWithHttpInfo($client_id, $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) + public function apiAppUpdateWithHttpInfo(string $client_id, Model\ApiAppUpdateRequest $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) { $request = $this->apiAppUpdateRequest($client_id, $api_app_update_request, $contentType); @@ -1496,14 +1441,14 @@ public function apiAppUpdateWithHttpInfo($client_id, $api_app_update_request, st } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1516,14 +1461,14 @@ public function apiAppUpdateWithHttpInfo($client_id, $api_app_update_request, st sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1532,18 +1477,17 @@ public function apiAppUpdateWithHttpInfo($client_id, $api_app_update_request, st if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\ApiAppGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\ApiAppGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1560,20 +1504,19 @@ public function apiAppUpdateWithHttpInfo($client_id, $api_app_update_request, st return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\ApiAppGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1590,11 +1533,9 @@ public function apiAppUpdateWithHttpInfo($client_id, $api_app_update_request, st return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1607,7 +1548,6 @@ public function apiAppUpdateWithHttpInfo($client_id, $api_app_update_request, st ); $e->setResponseObject($data); break; - } throw $e; } @@ -1618,15 +1558,15 @@ public function apiAppUpdateWithHttpInfo($client_id, $api_app_update_request, st * * Update API App * - * @param string $client_id The client id of the API App to update. (required) - * @param \Dropbox\Sign\Model\ApiAppUpdateRequest $api_app_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation + * @param string $client_id The client id of the API App to update. (required) + * @param Model\ApiAppUpdateRequest $api_app_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppUpdate. This method will eventually become unavailable */ - public function apiAppUpdateAsync($client_id, $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) + public function apiAppUpdateAsync(string $client_id, Model\ApiAppUpdateRequest $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) { return $this->apiAppUpdateAsyncWithHttpInfo($client_id, $api_app_update_request, $contentType) ->then( @@ -1641,15 +1581,15 @@ function ($response) { * * Update API App * - * @param string $client_id The client id of the API App to update. (required) - * @param \Dropbox\Sign\Model\ApiAppUpdateRequest $api_app_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation + * @param string $client_id The client id of the API App to update. (required) + * @param Model\ApiAppUpdateRequest $api_app_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppUpdate. This method will eventually become unavailable */ - public function apiAppUpdateAsyncWithHttpInfo($client_id, $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) + public function apiAppUpdateAsyncWithHttpInfo(string $client_id, Model\ApiAppUpdateRequest $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) { $returnType = '\Dropbox\Sign\Model\ApiAppGetResponse'; $request = $this->apiAppUpdateRequest($client_id, $api_app_update_request, $contentType); @@ -1659,9 +1599,9 @@ public function apiAppUpdateAsyncWithHttpInfo($client_id, $api_app_update_reques ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1670,7 +1610,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1684,7 +1624,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1693,32 +1633,30 @@ function ($exception) { /** * Create request for operation 'apiAppUpdate' * - * @param string $client_id The client id of the API App to update. (required) - * @param \Dropbox\Sign\Model\ApiAppUpdateRequest $api_app_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation + * @param string $client_id The client id of the API App to update. (required) + * @param Model\ApiAppUpdateRequest $api_app_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::apiAppUpdate. This method will eventually become unavailable */ - public function apiAppUpdateRequest($client_id, $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) + public function apiAppUpdateRequest(string $client_id, Model\ApiAppUpdateRequest $api_app_update_request, string $contentType = self::contentTypes['apiAppUpdate'][0]) { - // verify the required parameter 'client_id' is set if ($client_id === null || (is_array($client_id) && count($client_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $client_id when calling apiAppUpdate' ); } // verify the required parameter 'api_app_update_request' is set if ($api_app_update_request === null || (is_array($api_app_update_request) && count($api_app_update_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $api_app_update_request when calling apiAppUpdate' ); } - $resourcePath = '/api_app/{client_id}'; $formParams = []; $queryParams = []; @@ -1732,19 +1670,17 @@ public function apiAppUpdateRequest($client_id, $api_app_update_request, string $multipart = !empty($formParams); - // path params if ($client_id !== null) { $resourcePath = str_replace( - '{' . 'client_id' . '}', + '{client_id}', ObjectSerializer::toPathValue($client_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1752,7 +1688,7 @@ public function apiAppUpdateRequest($client_id, $api_app_update_request, string // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($api_app_update_request)); } else { $httpBody = $api_app_update_request; @@ -1765,7 +1701,7 @@ public function apiAppUpdateRequest($client_id, $api_app_update_request, string foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1782,9 +1718,8 @@ public function apiAppUpdateRequest($client_id, $api_app_update_request, string $payloadHook('multipart', $multipartContents, $api_app_update_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1825,8 +1760,8 @@ public function apiAppUpdateRequest($client_id, $api_app_update_request, string /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -1834,7 +1769,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -1850,8 +1785,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -1861,9 +1796,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -1882,8 +1817,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/BulkSendJobApi.php b/sdks/php/src/Api/BulkSendJobApi.php index 3a95c799b..77ad055c7 100644 --- a/sdks/php/src/Api/BulkSendJobApi.php +++ b/sdks/php/src/Api/BulkSendJobApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,34 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; /** * BulkSendJobApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class BulkSendJobApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'bulkSendJobGet' => [ 'application/json', @@ -86,16 +79,13 @@ class BulkSendJobApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -109,7 +99,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -146,15 +136,15 @@ public function getResponse() * * Get Bulk Send Job * - * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) - * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) + * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\BulkSendJobGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\BulkSendJobGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function bulkSendJobGet($bulk_send_job_id, $page = 1, $page_size = 20) + public function bulkSendJobGet(string $bulk_send_job_id, int $page = 1, int $page_size = 20) { list($response) = $this->bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page, $page_size); return $response; @@ -165,17 +155,17 @@ public function bulkSendJobGet($bulk_send_job_id, $page = 1, $page_size = 20) * * Get Bulk Send Job * - * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) - * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation + * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) + * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\BulkSendJobGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\BulkSendJobGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobGet. This method will eventually become unavailable */ - public function bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) + public function bulkSendJobGetWithHttpInfo(string $bulk_send_job_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) { $request = $this->bulkSendJobGetRequest($bulk_send_job_id, $page, $page_size, $contentType); @@ -187,14 +177,14 @@ public function bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page = 1, $page_s } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -207,14 +197,14 @@ public function bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page = 1, $page_s sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -223,18 +213,17 @@ public function bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page = 1, $page_s if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\BulkSendJobGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\BulkSendJobGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -251,20 +240,19 @@ public function bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page = 1, $page_s return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\BulkSendJobGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\BulkSendJobGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -281,11 +269,9 @@ public function bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page = 1, $page_s return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -298,7 +284,6 @@ public function bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page = 1, $page_s ); $e->setResponseObject($data); break; - } throw $e; } @@ -309,16 +294,16 @@ public function bulkSendJobGetWithHttpInfo($bulk_send_job_id, $page = 1, $page_s * * Get Bulk Send Job * - * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) - * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation + * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) + * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobGet. This method will eventually become unavailable */ - public function bulkSendJobGetAsync($bulk_send_job_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) + public function bulkSendJobGetAsync(string $bulk_send_job_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) { return $this->bulkSendJobGetAsyncWithHttpInfo($bulk_send_job_id, $page, $page_size, $contentType) ->then( @@ -333,16 +318,16 @@ function ($response) { * * Get Bulk Send Job * - * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) - * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation + * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) + * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobGet. This method will eventually become unavailable */ - public function bulkSendJobGetAsyncWithHttpInfo($bulk_send_job_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) + public function bulkSendJobGetAsyncWithHttpInfo(string $bulk_send_job_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) { $returnType = '\Dropbox\Sign\Model\BulkSendJobGetResponse'; $request = $this->bulkSendJobGetRequest($bulk_send_job_id, $page, $page_size, $contentType); @@ -352,9 +337,9 @@ public function bulkSendJobGetAsyncWithHttpInfo($bulk_send_job_id, $page = 1, $p ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -363,7 +348,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -377,7 +362,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -386,28 +371,24 @@ function ($exception) { /** * Create request for operation 'bulkSendJobGet' * - * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) - * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation + * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) + * @param int $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobGet. This method will eventually become unavailable */ - public function bulkSendJobGetRequest($bulk_send_job_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) + public function bulkSendJobGetRequest(string $bulk_send_job_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobGet'][0]) { - // verify the required parameter 'bulk_send_job_id' is set if ($bulk_send_job_id === null || (is_array($bulk_send_job_id) && count($bulk_send_job_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $bulk_send_job_id when calling bulkSendJobGet' ); } - - - $resourcePath = '/bulk_send_job/{bulk_send_job_id}'; $formParams = []; $queryParams = []; @@ -434,19 +415,17 @@ public function bulkSendJobGetRequest($bulk_send_job_id, $page = 1, $page_size = false // required ) ?? []); - // path params if ($bulk_send_job_id !== null) { $resourcePath = str_replace( - '{' . 'bulk_send_job_id' . '}', + '{bulk_send_job_id}', ObjectSerializer::toPathValue($bulk_send_job_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -460,7 +439,7 @@ public function bulkSendJobGetRequest($bulk_send_job_id, $page = 1, $page_size = foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -474,9 +453,8 @@ public function bulkSendJobGetRequest($bulk_send_job_id, $page = 1, $page_size = } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -519,14 +497,14 @@ public function bulkSendJobGetRequest($bulk_send_job_id, $page = 1, $page_size = * * List Bulk Send Jobs * - * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\BulkSendJobListResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\BulkSendJobListResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function bulkSendJobList($page = 1, $page_size = 20) + public function bulkSendJobList(int $page = 1, int $page_size = 20) { list($response) = $this->bulkSendJobListWithHttpInfo($page, $page_size); return $response; @@ -537,16 +515,16 @@ public function bulkSendJobList($page = 1, $page_size = 20) * * List Bulk Send Jobs * - * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation + * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\BulkSendJobListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\BulkSendJobListResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobList. This method will eventually become unavailable */ - public function bulkSendJobListWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) + public function bulkSendJobListWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) { $request = $this->bulkSendJobListRequest($page, $page_size, $contentType); @@ -558,14 +536,14 @@ public function bulkSendJobListWithHttpInfo($page = 1, $page_size = 20, string $ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -578,14 +556,14 @@ public function bulkSendJobListWithHttpInfo($page = 1, $page_size = 20, string $ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -594,18 +572,17 @@ public function bulkSendJobListWithHttpInfo($page = 1, $page_size = 20, string $ if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\BulkSendJobListResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\BulkSendJobListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -622,20 +599,19 @@ public function bulkSendJobListWithHttpInfo($page = 1, $page_size = 20, string $ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\BulkSendJobListResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\BulkSendJobListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -652,11 +628,9 @@ public function bulkSendJobListWithHttpInfo($page = 1, $page_size = 20, string $ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -669,7 +643,6 @@ public function bulkSendJobListWithHttpInfo($page = 1, $page_size = 20, string $ ); $e->setResponseObject($data); break; - } throw $e; } @@ -680,15 +653,15 @@ public function bulkSendJobListWithHttpInfo($page = 1, $page_size = 20, string $ * * List Bulk Send Jobs * - * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation + * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobList. This method will eventually become unavailable */ - public function bulkSendJobListAsync($page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) + public function bulkSendJobListAsync(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) { return $this->bulkSendJobListAsyncWithHttpInfo($page, $page_size, $contentType) ->then( @@ -703,15 +676,15 @@ function ($response) { * * List Bulk Send Jobs * - * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation + * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobList. This method will eventually become unavailable */ - public function bulkSendJobListAsyncWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) + public function bulkSendJobListAsyncWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) { $returnType = '\Dropbox\Sign\Model\BulkSendJobListResponse'; $request = $this->bulkSendJobListRequest($page, $page_size, $contentType); @@ -721,9 +694,9 @@ public function bulkSendJobListAsyncWithHttpInfo($page = 1, $page_size = 20, str ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -732,7 +705,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -746,7 +719,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -755,20 +728,16 @@ function ($exception) { /** * Create request for operation 'bulkSendJobList' * - * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation + * @param int $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::bulkSendJobList. This method will eventually become unavailable */ - public function bulkSendJobListRequest($page = 1, $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) + public function bulkSendJobListRequest(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['bulkSendJobList'][0]) { - - - - $resourcePath = '/bulk_send_job/list'; $formParams = []; $queryParams = []; @@ -795,11 +764,8 @@ public function bulkSendJobListRequest($page = 1, $page_size = 20, string $conte false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -813,7 +779,7 @@ public function bulkSendJobListRequest($page = 1, $page_size = 20, string $conte foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -827,9 +793,8 @@ public function bulkSendJobListRequest($page = 1, $page_size = 20, string $conte } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -870,8 +835,8 @@ public function bulkSendJobListRequest($page = 1, $page_size = 20, string $conte /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -879,7 +844,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -895,8 +860,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -906,9 +871,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -927,8 +892,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/EmbeddedApi.php b/sdks/php/src/Api/EmbeddedApi.php index baa672d7d..364e5f7e7 100644 --- a/sdks/php/src/Api/EmbeddedApi.php +++ b/sdks/php/src/Api/EmbeddedApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,34 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; /** * EmbeddedApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class EmbeddedApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'embeddedEditUrl' => [ 'application/json', @@ -86,16 +79,13 @@ class EmbeddedApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -109,7 +99,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -146,14 +136,14 @@ public function getResponse() * * Get Embedded Template Edit URL * - * @param string $template_id The id of the template to edit. (required) - * @param \Dropbox\Sign\Model\EmbeddedEditUrlRequest $embedded_edit_url_request embedded_edit_url_request (required) + * @param string $template_id The id of the template to edit. (required) + * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request embedded_edit_url_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\EmbeddedEditUrlResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\EmbeddedEditUrlResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function embeddedEditUrl($template_id, $embedded_edit_url_request) + public function embeddedEditUrl(string $template_id, Model\EmbeddedEditUrlRequest $embedded_edit_url_request) { list($response) = $this->embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_request); return $response; @@ -164,16 +154,16 @@ public function embeddedEditUrl($template_id, $embedded_edit_url_request) * * Get Embedded Template Edit URL * - * @param string $template_id The id of the template to edit. (required) - * @param \Dropbox\Sign\Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation + * @param string $template_id The id of the template to edit. (required) + * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\EmbeddedEditUrlResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\EmbeddedEditUrlResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedEditUrl. This method will eventually become unavailable */ - public function embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) + public function embeddedEditUrlWithHttpInfo(string $template_id, Model\EmbeddedEditUrlRequest $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) { $request = $this->embeddedEditUrlRequest($template_id, $embedded_edit_url_request, $contentType); @@ -185,14 +175,14 @@ public function embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_req } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -205,14 +195,14 @@ public function embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_req sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -221,18 +211,17 @@ public function embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_req if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\EmbeddedEditUrlResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\EmbeddedEditUrlResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -249,20 +238,19 @@ public function embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_req return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\EmbeddedEditUrlResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\EmbeddedEditUrlResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -279,11 +267,9 @@ public function embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_req return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -296,7 +282,6 @@ public function embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_req ); $e->setResponseObject($data); break; - } throw $e; } @@ -307,15 +292,15 @@ public function embeddedEditUrlWithHttpInfo($template_id, $embedded_edit_url_req * * Get Embedded Template Edit URL * - * @param string $template_id The id of the template to edit. (required) - * @param \Dropbox\Sign\Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation + * @param string $template_id The id of the template to edit. (required) + * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedEditUrl. This method will eventually become unavailable */ - public function embeddedEditUrlAsync($template_id, $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) + public function embeddedEditUrlAsync(string $template_id, Model\EmbeddedEditUrlRequest $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) { return $this->embeddedEditUrlAsyncWithHttpInfo($template_id, $embedded_edit_url_request, $contentType) ->then( @@ -330,15 +315,15 @@ function ($response) { * * Get Embedded Template Edit URL * - * @param string $template_id The id of the template to edit. (required) - * @param \Dropbox\Sign\Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation + * @param string $template_id The id of the template to edit. (required) + * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedEditUrl. This method will eventually become unavailable */ - public function embeddedEditUrlAsyncWithHttpInfo($template_id, $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) + public function embeddedEditUrlAsyncWithHttpInfo(string $template_id, Model\EmbeddedEditUrlRequest $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) { $returnType = '\Dropbox\Sign\Model\EmbeddedEditUrlResponse'; $request = $this->embeddedEditUrlRequest($template_id, $embedded_edit_url_request, $contentType); @@ -348,9 +333,9 @@ public function embeddedEditUrlAsyncWithHttpInfo($template_id, $embedded_edit_ur ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -359,7 +344,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -373,7 +358,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -382,32 +367,30 @@ function ($exception) { /** * Create request for operation 'embeddedEditUrl' * - * @param string $template_id The id of the template to edit. (required) - * @param \Dropbox\Sign\Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation + * @param string $template_id The id of the template to edit. (required) + * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedEditUrl. This method will eventually become unavailable */ - public function embeddedEditUrlRequest($template_id, $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) + public function embeddedEditUrlRequest(string $template_id, Model\EmbeddedEditUrlRequest $embedded_edit_url_request, string $contentType = self::contentTypes['embeddedEditUrl'][0]) { - // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_id when calling embeddedEditUrl' ); } // verify the required parameter 'embedded_edit_url_request' is set if ($embedded_edit_url_request === null || (is_array($embedded_edit_url_request) && count($embedded_edit_url_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $embedded_edit_url_request when calling embeddedEditUrl' ); } - $resourcePath = '/embedded/edit_url/{template_id}'; $formParams = []; $queryParams = []; @@ -421,19 +404,17 @@ public function embeddedEditUrlRequest($template_id, $embedded_edit_url_request, $multipart = !empty($formParams); - // path params if ($template_id !== null) { $resourcePath = str_replace( - '{' . 'template_id' . '}', + '{template_id}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -441,7 +422,7 @@ public function embeddedEditUrlRequest($template_id, $embedded_edit_url_request, // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($embedded_edit_url_request)); } else { $httpBody = $embedded_edit_url_request; @@ -454,7 +435,7 @@ public function embeddedEditUrlRequest($template_id, $embedded_edit_url_request, foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -471,9 +452,8 @@ public function embeddedEditUrlRequest($template_id, $embedded_edit_url_request, $payloadHook('multipart', $multipartContents, $embedded_edit_url_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -516,13 +496,13 @@ public function embeddedEditUrlRequest($template_id, $embedded_edit_url_request, * * Get Embedded Sign URL * - * @param string $signature_id The id of the signature to get a signature url for. (required) + * @param string $signature_id The id of the signature to get a signature url for. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\EmbeddedSignUrlResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\EmbeddedSignUrlResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function embeddedSignUrl($signature_id) + public function embeddedSignUrl(string $signature_id) { list($response) = $this->embeddedSignUrlWithHttpInfo($signature_id); return $response; @@ -533,15 +513,15 @@ public function embeddedSignUrl($signature_id) * * Get Embedded Sign URL * - * @param string $signature_id The id of the signature to get a signature url for. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation + * @param string $signature_id The id of the signature to get a signature url for. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\EmbeddedSignUrlResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\EmbeddedSignUrlResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedSignUrl. This method will eventually become unavailable */ - public function embeddedSignUrlWithHttpInfo($signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) + public function embeddedSignUrlWithHttpInfo(string $signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) { $request = $this->embeddedSignUrlRequest($signature_id, $contentType); @@ -553,14 +533,14 @@ public function embeddedSignUrlWithHttpInfo($signature_id, string $contentType = } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -573,14 +553,14 @@ public function embeddedSignUrlWithHttpInfo($signature_id, string $contentType = sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -589,18 +569,17 @@ public function embeddedSignUrlWithHttpInfo($signature_id, string $contentType = if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\EmbeddedSignUrlResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\EmbeddedSignUrlResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -617,20 +596,19 @@ public function embeddedSignUrlWithHttpInfo($signature_id, string $contentType = return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\EmbeddedSignUrlResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\EmbeddedSignUrlResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -647,11 +625,9 @@ public function embeddedSignUrlWithHttpInfo($signature_id, string $contentType = return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -664,7 +640,6 @@ public function embeddedSignUrlWithHttpInfo($signature_id, string $contentType = ); $e->setResponseObject($data); break; - } throw $e; } @@ -675,14 +650,14 @@ public function embeddedSignUrlWithHttpInfo($signature_id, string $contentType = * * Get Embedded Sign URL * - * @param string $signature_id The id of the signature to get a signature url for. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation + * @param string $signature_id The id of the signature to get a signature url for. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedSignUrl. This method will eventually become unavailable */ - public function embeddedSignUrlAsync($signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) + public function embeddedSignUrlAsync(string $signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) { return $this->embeddedSignUrlAsyncWithHttpInfo($signature_id, $contentType) ->then( @@ -697,14 +672,14 @@ function ($response) { * * Get Embedded Sign URL * - * @param string $signature_id The id of the signature to get a signature url for. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation + * @param string $signature_id The id of the signature to get a signature url for. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedSignUrl. This method will eventually become unavailable */ - public function embeddedSignUrlAsyncWithHttpInfo($signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) + public function embeddedSignUrlAsyncWithHttpInfo(string $signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) { $returnType = '\Dropbox\Sign\Model\EmbeddedSignUrlResponse'; $request = $this->embeddedSignUrlRequest($signature_id, $contentType); @@ -714,9 +689,9 @@ public function embeddedSignUrlAsyncWithHttpInfo($signature_id, string $contentT ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -725,7 +700,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -739,7 +714,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -748,24 +723,22 @@ function ($exception) { /** * Create request for operation 'embeddedSignUrl' * - * @param string $signature_id The id of the signature to get a signature url for. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation + * @param string $signature_id The id of the signature to get a signature url for. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::embeddedSignUrl. This method will eventually become unavailable */ - public function embeddedSignUrlRequest($signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) + public function embeddedSignUrlRequest(string $signature_id, string $contentType = self::contentTypes['embeddedSignUrl'][0]) { - // verify the required parameter 'signature_id' is set if ($signature_id === null || (is_array($signature_id) && count($signature_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_id when calling embeddedSignUrl' ); } - $resourcePath = '/embedded/sign_url/{signature_id}'; $formParams = []; $queryParams = []; @@ -773,20 +746,17 @@ public function embeddedSignUrlRequest($signature_id, string $contentType = self $httpBody = ''; $multipart = false; - - // path params if ($signature_id !== null) { $resourcePath = str_replace( - '{' . 'signature_id' . '}', + '{signature_id}', ObjectSerializer::toPathValue($signature_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -800,7 +770,7 @@ public function embeddedSignUrlRequest($signature_id, string $contentType = self foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -814,9 +784,8 @@ public function embeddedSignUrlRequest($signature_id, string $contentType = self } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -857,8 +826,8 @@ public function embeddedSignUrlRequest($signature_id, string $contentType = self /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -866,7 +835,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -882,8 +851,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -893,9 +862,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -914,8 +883,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/FaxApi.php b/sdks/php/src/Api/FaxApi.php index 194b3e3e6..2669fedbc 100644 --- a/sdks/php/src/Api/FaxApi.php +++ b/sdks/php/src/Api/FaxApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,35 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; +use SplFileObject; /** * FaxApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class FaxApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'faxDelete' => [ 'application/json', @@ -96,16 +90,13 @@ class FaxApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -119,7 +110,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -156,13 +147,12 @@ public function getResponse() * * Delete Fax * - * @param string $fax_id Fax ID (required) + * @param string $fax_id Fax ID (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return void + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxDelete($fax_id) + public function faxDelete(string $fax_id) { $this->faxDeleteWithHttpInfo($fax_id); } @@ -172,15 +162,15 @@ public function faxDelete($fax_id) * * Delete Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable */ - public function faxDeleteWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + public function faxDeleteWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) { $request = $this->faxDeleteRequest($fax_id, $contentType); @@ -192,14 +182,14 @@ public function faxDeleteWithHttpInfo($fax_id, string $contentType = self::conte } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -212,23 +202,20 @@ public function faxDeleteWithHttpInfo($fax_id, string $contentType = self::conte sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { - } throw $e; } @@ -239,14 +226,14 @@ public function faxDeleteWithHttpInfo($fax_id, string $contentType = self::conte * * Delete Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable */ - public function faxDeleteAsync($fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + public function faxDeleteAsync(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) { return $this->faxDeleteAsyncWithHttpInfo($fax_id, $contentType) ->then( @@ -261,14 +248,14 @@ function ($response) { * * Delete Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable */ - public function faxDeleteAsyncWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + public function faxDeleteAsyncWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) { $returnType = ''; $request = $this->faxDeleteRequest($fax_id, $contentType); @@ -276,7 +263,7 @@ public function faxDeleteAsyncWithHttpInfo($fax_id, string $contentType = self:: return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) use ($returnType) { + function ($response) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -290,7 +277,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -299,24 +286,22 @@ function ($exception) { /** * Create request for operation 'faxDelete' * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable */ - public function faxDeleteRequest($fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + public function faxDeleteRequest(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) { - // verify the required parameter 'fax_id' is set if ($fax_id === null || (is_array($fax_id) && count($fax_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $fax_id when calling faxDelete' ); } - $resourcePath = '/fax/{fax_id}'; $formParams = []; $queryParams = []; @@ -324,20 +309,17 @@ public function faxDeleteRequest($fax_id, string $contentType = self::contentTyp $httpBody = ''; $multipart = false; - - // path params if ($fax_id !== null) { $resourcePath = str_replace( - '{' . 'fax_id' . '}', + '{fax_id}', ObjectSerializer::toPathValue($fax_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -351,7 +333,7 @@ public function faxDeleteRequest($fax_id, string $contentType = self::contentTyp foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -365,9 +347,8 @@ public function faxDeleteRequest($fax_id, string $contentType = self::contentTyp } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -406,13 +387,13 @@ public function faxDeleteRequest($fax_id, string $contentType = self::contentTyp * * Download Fax Files * - * @param string $fax_id Fax ID (required) + * @param string $fax_id Fax ID (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \SplFileObject|\Dropbox\Sign\Model\ErrorResponse + * @return SplFileObject + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxFiles($fax_id) + public function faxFiles(string $fax_id) { list($response) = $this->faxFilesWithHttpInfo($fax_id); return $response; @@ -423,15 +404,15 @@ public function faxFiles($fax_id) * * Download Fax Files * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException * @return array of \SplFileObject|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable */ - public function faxFilesWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) { $request = $this->faxFilesRequest($fax_id, $contentType); @@ -443,14 +424,14 @@ public function faxFilesWithHttpInfo($fax_id, string $contentType = self::conten } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -463,14 +444,14 @@ public function faxFilesWithHttpInfo($fax_id, string $contentType = self::conten sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -479,18 +460,17 @@ public function faxFilesWithHttpInfo($fax_id, string $contentType = self::conten if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\SplFileObject' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\SplFileObject' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -507,20 +487,19 @@ public function faxFilesWithHttpInfo($fax_id, string $contentType = self::conten return [ ObjectSerializer::deserialize($content, '\SplFileObject', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\SplFileObject'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -537,11 +516,9 @@ public function faxFilesWithHttpInfo($fax_id, string $contentType = self::conten return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -554,7 +531,6 @@ public function faxFilesWithHttpInfo($fax_id, string $contentType = self::conten ); $e->setResponseObject($data); break; - } throw $e; } @@ -565,14 +541,14 @@ public function faxFilesWithHttpInfo($fax_id, string $contentType = self::conten * * Download Fax Files * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable */ - public function faxFilesAsync($fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + public function faxFilesAsync(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) { return $this->faxFilesAsyncWithHttpInfo($fax_id, $contentType) ->then( @@ -587,14 +563,14 @@ function ($response) { * * Download Fax Files * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable */ - public function faxFilesAsyncWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + public function faxFilesAsyncWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) { $returnType = '\SplFileObject'; $request = $this->faxFilesRequest($fax_id, $contentType); @@ -604,9 +580,9 @@ public function faxFilesAsyncWithHttpInfo($fax_id, string $contentType = self::c ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -615,7 +591,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -629,7 +605,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -638,24 +614,22 @@ function ($exception) { /** * Create request for operation 'faxFiles' * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable */ - public function faxFilesRequest($fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + public function faxFilesRequest(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) { - // verify the required parameter 'fax_id' is set if ($fax_id === null || (is_array($fax_id) && count($fax_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $fax_id when calling faxFiles' ); } - $resourcePath = '/fax/files/{fax_id}'; $formParams = []; $queryParams = []; @@ -663,20 +637,17 @@ public function faxFilesRequest($fax_id, string $contentType = self::contentType $httpBody = ''; $multipart = false; - - // path params if ($fax_id !== null) { $resourcePath = str_replace( - '{' . 'fax_id' . '}', + '{fax_id}', ObjectSerializer::toPathValue($fax_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/json', ], + $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/json'], $contentType, $multipart ); @@ -690,7 +661,7 @@ public function faxFilesRequest($fax_id, string $contentType = self::contentType foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -704,9 +675,8 @@ public function faxFilesRequest($fax_id, string $contentType = self::contentType } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -745,13 +715,13 @@ public function faxFilesRequest($fax_id, string $contentType = self::contentType * * Get Fax * - * @param string $fax_id Fax ID (required) + * @param string $fax_id Fax ID (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FaxGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FaxGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxGet($fax_id) + public function faxGet(string $fax_id) { list($response) = $this->faxGetWithHttpInfo($fax_id); return $response; @@ -762,15 +732,15 @@ public function faxGet($fax_id) * * Get Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FaxGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FaxGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable */ - public function faxGetWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxGet'][0]) + public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) { $request = $this->faxGetRequest($fax_id, $contentType); @@ -782,14 +752,14 @@ public function faxGetWithHttpInfo($fax_id, string $contentType = self::contentT } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -802,14 +772,14 @@ public function faxGetWithHttpInfo($fax_id, string $contentType = self::contentT sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -818,18 +788,17 @@ public function faxGetWithHttpInfo($fax_id, string $contentType = self::contentT if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FaxGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -846,20 +815,19 @@ public function faxGetWithHttpInfo($fax_id, string $contentType = self::contentT return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -876,11 +844,9 @@ public function faxGetWithHttpInfo($fax_id, string $contentType = self::contentT return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -893,7 +859,6 @@ public function faxGetWithHttpInfo($fax_id, string $contentType = self::contentT ); $e->setResponseObject($data); break; - } throw $e; } @@ -904,14 +869,14 @@ public function faxGetWithHttpInfo($fax_id, string $contentType = self::contentT * * Get Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable */ - public function faxGetAsync($fax_id, string $contentType = self::contentTypes['faxGet'][0]) + public function faxGetAsync(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) { return $this->faxGetAsyncWithHttpInfo($fax_id, $contentType) ->then( @@ -926,14 +891,14 @@ function ($response) { * * Get Fax * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable */ - public function faxGetAsyncWithHttpInfo($fax_id, string $contentType = self::contentTypes['faxGet'][0]) + public function faxGetAsyncWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) { $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; $request = $this->faxGetRequest($fax_id, $contentType); @@ -943,9 +908,9 @@ public function faxGetAsyncWithHttpInfo($fax_id, string $contentType = self::con ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -954,7 +919,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -968,7 +933,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -977,24 +942,22 @@ function ($exception) { /** * Create request for operation 'faxGet' * - * @param string $fax_id Fax ID (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable */ - public function faxGetRequest($fax_id, string $contentType = self::contentTypes['faxGet'][0]) + public function faxGetRequest(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) { - // verify the required parameter 'fax_id' is set if ($fax_id === null || (is_array($fax_id) && count($fax_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $fax_id when calling faxGet' ); } - $resourcePath = '/fax/{fax_id}'; $formParams = []; $queryParams = []; @@ -1002,20 +965,17 @@ public function faxGetRequest($fax_id, string $contentType = self::contentTypes[ $httpBody = ''; $multipart = false; - - // path params if ($fax_id !== null) { $resourcePath = str_replace( - '{' . 'fax_id' . '}', + '{fax_id}', ObjectSerializer::toPathValue($fax_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1029,7 +989,7 @@ public function faxGetRequest($fax_id, string $contentType = self::contentTypes[ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1043,9 +1003,8 @@ public function faxGetRequest($fax_id, string $contentType = self::contentTypes[ } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1084,14 +1043,14 @@ public function faxGetRequest($fax_id, string $contentType = self::contentTypes[ * * Lists Faxes * - * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FaxListResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FaxListResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxList($page = 1, $page_size = 20) + public function faxList(int $page = 1, int $page_size = 20) { list($response) = $this->faxListWithHttpInfo($page, $page_size); return $response; @@ -1102,16 +1061,16 @@ public function faxList($page = 1, $page_size = 20) * * Lists Faxes * - * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FaxListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FaxListResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxList. This method will eventually become unavailable */ - public function faxListWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) { $request = $this->faxListRequest($page, $page_size, $contentType); @@ -1123,14 +1082,14 @@ public function faxListWithHttpInfo($page = 1, $page_size = 20, string $contentT } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1143,14 +1102,14 @@ public function faxListWithHttpInfo($page = 1, $page_size = 20, string $contentT sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1159,18 +1118,17 @@ public function faxListWithHttpInfo($page = 1, $page_size = 20, string $contentT if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxListResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FaxListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1187,20 +1145,19 @@ public function faxListWithHttpInfo($page = 1, $page_size = 20, string $contentT return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxListResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FaxListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1217,11 +1174,9 @@ public function faxListWithHttpInfo($page = 1, $page_size = 20, string $contentT return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1234,7 +1189,6 @@ public function faxListWithHttpInfo($page = 1, $page_size = 20, string $contentT ); $e->setResponseObject($data); break; - } throw $e; } @@ -1245,15 +1199,15 @@ public function faxListWithHttpInfo($page = 1, $page_size = 20, string $contentT * * Lists Faxes * - * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxList. This method will eventually become unavailable */ - public function faxListAsync($page = 1, $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + public function faxListAsync(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) { return $this->faxListAsyncWithHttpInfo($page, $page_size, $contentType) ->then( @@ -1268,15 +1222,15 @@ function ($response) { * * Lists Faxes * - * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxList. This method will eventually become unavailable */ - public function faxListAsyncWithHttpInfo($page = 1, $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + public function faxListAsyncWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) { $returnType = '\Dropbox\Sign\Model\FaxListResponse'; $request = $this->faxListRequest($page, $page_size, $contentType); @@ -1286,9 +1240,9 @@ public function faxListAsyncWithHttpInfo($page = 1, $page_size = 20, string $con ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1297,7 +1251,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1311,7 +1265,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1320,28 +1274,26 @@ function ($exception) { /** * Create request for operation 'faxList' * - * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxList. This method will eventually become unavailable */ - public function faxListRequest($page = 1, $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + public function faxListRequest(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) { - if ($page !== null && $page < 1) { - throw new \InvalidArgumentException('invalid value for "$page" when calling FaxApi.faxList, must be bigger than or equal to 1.'); + throw new InvalidArgumentException('invalid value for "$page" when calling FaxApi.faxList, must be bigger than or equal to 1.'); } - + if ($page_size !== null && $page_size > 100) { - throw new \InvalidArgumentException('invalid value for "$page_size" when calling FaxApi.faxList, must be smaller than or equal to 100.'); + throw new InvalidArgumentException('invalid value for "$page_size" when calling FaxApi.faxList, must be smaller than or equal to 100.'); } if ($page_size !== null && $page_size < 1) { - throw new \InvalidArgumentException('invalid value for "$page_size" when calling FaxApi.faxList, must be bigger than or equal to 1.'); + throw new InvalidArgumentException('invalid value for "$page_size" when calling FaxApi.faxList, must be bigger than or equal to 1.'); } - $resourcePath = '/fax/list'; $formParams = []; @@ -1369,11 +1321,8 @@ public function faxListRequest($page = 1, $page_size = 20, string $contentType = false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1387,7 +1336,7 @@ public function faxListRequest($page = 1, $page_size = 20, string $contentType = foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1401,9 +1350,8 @@ public function faxListRequest($page = 1, $page_size = 20, string $contentType = } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1442,13 +1390,13 @@ public function faxListRequest($page = 1, $page_size = 20, string $contentType = * * Send Fax * - * @param \Dropbox\Sign\Model\FaxSendRequest $fax_send_request fax_send_request (required) + * @param Model\FaxSendRequest $fax_send_request fax_send_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FaxGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FaxGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxSend($fax_send_request) + public function faxSend(Model\FaxSendRequest $fax_send_request) { list($response) = $this->faxSendWithHttpInfo($fax_send_request); return $response; @@ -1459,15 +1407,15 @@ public function faxSend($fax_send_request) * * Send Fax * - * @param \Dropbox\Sign\Model\FaxSendRequest $fax_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * @param Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FaxGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FaxGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable */ - public function faxSendWithHttpInfo($fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) { $request = $this->faxSendRequest($fax_send_request, $contentType); @@ -1479,14 +1427,14 @@ public function faxSendWithHttpInfo($fax_send_request, string $contentType = sel } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1499,14 +1447,14 @@ public function faxSendWithHttpInfo($fax_send_request, string $contentType = sel sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1515,18 +1463,17 @@ public function faxSendWithHttpInfo($fax_send_request, string $contentType = sel if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FaxGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1543,20 +1490,19 @@ public function faxSendWithHttpInfo($fax_send_request, string $contentType = sel return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1573,11 +1519,9 @@ public function faxSendWithHttpInfo($fax_send_request, string $contentType = sel return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1590,7 +1534,6 @@ public function faxSendWithHttpInfo($fax_send_request, string $contentType = sel ); $e->setResponseObject($data); break; - } throw $e; } @@ -1601,14 +1544,14 @@ public function faxSendWithHttpInfo($fax_send_request, string $contentType = sel * * Send Fax * - * @param \Dropbox\Sign\Model\FaxSendRequest $fax_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * @param Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable */ - public function faxSendAsync($fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + public function faxSendAsync(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) { return $this->faxSendAsyncWithHttpInfo($fax_send_request, $contentType) ->then( @@ -1623,14 +1566,14 @@ function ($response) { * * Send Fax * - * @param \Dropbox\Sign\Model\FaxSendRequest $fax_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * @param Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable */ - public function faxSendAsyncWithHttpInfo($fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + public function faxSendAsyncWithHttpInfo(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) { $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; $request = $this->faxSendRequest($fax_send_request, $contentType); @@ -1640,9 +1583,9 @@ public function faxSendAsyncWithHttpInfo($fax_send_request, string $contentType ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1651,7 +1594,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1665,7 +1608,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1674,24 +1617,22 @@ function ($exception) { /** * Create request for operation 'faxSend' * - * @param \Dropbox\Sign\Model\FaxSendRequest $fax_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * @param Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable */ - public function faxSendRequest($fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + public function faxSendRequest(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) { - // verify the required parameter 'fax_send_request' is set if ($fax_send_request === null || (is_array($fax_send_request) && count($fax_send_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $fax_send_request when calling faxSend' ); } - $resourcePath = '/fax/send'; $formParams = []; $queryParams = []; @@ -1705,11 +1646,8 @@ public function faxSendRequest($fax_send_request, string $contentType = self::co $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1717,7 +1655,7 @@ public function faxSendRequest($fax_send_request, string $contentType = self::co // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_send_request)); } else { $httpBody = $fax_send_request; @@ -1730,7 +1668,7 @@ public function faxSendRequest($fax_send_request, string $contentType = self::co foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1747,9 +1685,8 @@ public function faxSendRequest($fax_send_request, string $contentType = self::co $payloadHook('multipart', $multipartContents, $fax_send_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1786,8 +1723,8 @@ public function faxSendRequest($fax_send_request, string $contentType = self::co /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -1795,7 +1732,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -1811,8 +1748,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -1822,9 +1759,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -1843,8 +1780,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/FaxLineApi.php b/sdks/php/src/Api/FaxLineApi.php index 4055af748..baeb810b1 100644 --- a/sdks/php/src/Api/FaxLineApi.php +++ b/sdks/php/src/Api/FaxLineApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,34 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; /** * FaxLineApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class FaxLineApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'faxLineAddUser' => [ 'application/json', @@ -101,16 +94,13 @@ class FaxLineApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -124,7 +114,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -161,13 +151,13 @@ public function getResponse() * * Add Fax Line User * - * @param \Dropbox\Sign\Model\FaxLineAddUserRequest $fax_line_add_user_request fax_line_add_user_request (required) + * @param Model\FaxLineAddUserRequest $fax_line_add_user_request fax_line_add_user_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FaxLineResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxLineAddUser($fax_line_add_user_request) + public function faxLineAddUser(Model\FaxLineAddUserRequest $fax_line_add_user_request) { list($response) = $this->faxLineAddUserWithHttpInfo($fax_line_add_user_request); return $response; @@ -178,15 +168,15 @@ public function faxLineAddUser($fax_line_add_user_request) * * Add Fax Line User * - * @param \Dropbox\Sign\Model\FaxLineAddUserRequest $fax_line_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation + * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FaxLineResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAddUser. This method will eventually become unavailable */ - public function faxLineAddUserWithHttpInfo($fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) + public function faxLineAddUserWithHttpInfo(Model\FaxLineAddUserRequest $fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) { $request = $this->faxLineAddUserRequest($fax_line_add_user_request, $contentType); @@ -198,14 +188,14 @@ public function faxLineAddUserWithHttpInfo($fax_line_add_user_request, string $c } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -218,14 +208,14 @@ public function faxLineAddUserWithHttpInfo($fax_line_add_user_request, string $c sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -234,18 +224,17 @@ public function faxLineAddUserWithHttpInfo($fax_line_add_user_request, string $c if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FaxLineResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -262,20 +251,19 @@ public function faxLineAddUserWithHttpInfo($fax_line_add_user_request, string $c return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -292,11 +280,9 @@ public function faxLineAddUserWithHttpInfo($fax_line_add_user_request, string $c return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -309,7 +295,6 @@ public function faxLineAddUserWithHttpInfo($fax_line_add_user_request, string $c ); $e->setResponseObject($data); break; - } throw $e; } @@ -320,14 +305,14 @@ public function faxLineAddUserWithHttpInfo($fax_line_add_user_request, string $c * * Add Fax Line User * - * @param \Dropbox\Sign\Model\FaxLineAddUserRequest $fax_line_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation + * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAddUser. This method will eventually become unavailable */ - public function faxLineAddUserAsync($fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) + public function faxLineAddUserAsync(Model\FaxLineAddUserRequest $fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) { return $this->faxLineAddUserAsyncWithHttpInfo($fax_line_add_user_request, $contentType) ->then( @@ -342,14 +327,14 @@ function ($response) { * * Add Fax Line User * - * @param \Dropbox\Sign\Model\FaxLineAddUserRequest $fax_line_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation + * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAddUser. This method will eventually become unavailable */ - public function faxLineAddUserAsyncWithHttpInfo($fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) + public function faxLineAddUserAsyncWithHttpInfo(Model\FaxLineAddUserRequest $fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; $request = $this->faxLineAddUserRequest($fax_line_add_user_request, $contentType); @@ -359,9 +344,9 @@ public function faxLineAddUserAsyncWithHttpInfo($fax_line_add_user_request, stri ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -370,7 +355,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -384,7 +369,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -393,24 +378,22 @@ function ($exception) { /** * Create request for operation 'faxLineAddUser' * - * @param \Dropbox\Sign\Model\FaxLineAddUserRequest $fax_line_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation + * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAddUser. This method will eventually become unavailable */ - public function faxLineAddUserRequest($fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) + public function faxLineAddUserRequest(Model\FaxLineAddUserRequest $fax_line_add_user_request, string $contentType = self::contentTypes['faxLineAddUser'][0]) { - // verify the required parameter 'fax_line_add_user_request' is set if ($fax_line_add_user_request === null || (is_array($fax_line_add_user_request) && count($fax_line_add_user_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $fax_line_add_user_request when calling faxLineAddUser' ); } - $resourcePath = '/fax_line/add_user'; $formParams = []; $queryParams = []; @@ -424,11 +407,8 @@ public function faxLineAddUserRequest($fax_line_add_user_request, string $conten $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -436,7 +416,7 @@ public function faxLineAddUserRequest($fax_line_add_user_request, string $conten // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_line_add_user_request)); } else { $httpBody = $fax_line_add_user_request; @@ -449,7 +429,7 @@ public function faxLineAddUserRequest($fax_line_add_user_request, string $conten foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -466,9 +446,8 @@ public function faxLineAddUserRequest($fax_line_add_user_request, string $conten $payloadHook('multipart', $multipartContents, $fax_line_add_user_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -507,16 +486,16 @@ public function faxLineAddUserRequest($fax_line_add_user_request, string $conten * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country (required) - * @param string $state Filter area codes by state (optional) - * @param string $province Filter area codes by province (optional) - * @param string $city Filter area codes by city (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FaxLineAreaCodeGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FaxLineAreaCodeGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxLineAreaCodeGet($country, $state = null, $province = null, $city = null) + public function faxLineAreaCodeGet(string $country, string $state = null, string $province = null, string $city = null) { list($response) = $this->faxLineAreaCodeGetWithHttpInfo($country, $state, $province, $city); return $response; @@ -527,18 +506,18 @@ public function faxLineAreaCodeGet($country, $state = null, $province = null, $c * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country (required) - * @param string $state Filter area codes by state (optional) - * @param string $province Filter area codes by province (optional) - * @param string $city Filter area codes by city (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FaxLineAreaCodeGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FaxLineAreaCodeGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAreaCodeGet. This method will eventually become unavailable */ - public function faxLineAreaCodeGetWithHttpInfo($country, $state = null, $province = null, $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) + public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = null, string $province = null, string $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) { $request = $this->faxLineAreaCodeGetRequest($country, $state, $province, $city, $contentType); @@ -550,14 +529,14 @@ public function faxLineAreaCodeGetWithHttpInfo($country, $state = null, $provinc } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -570,14 +549,14 @@ public function faxLineAreaCodeGetWithHttpInfo($country, $state = null, $provinc sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -586,18 +565,17 @@ public function faxLineAreaCodeGetWithHttpInfo($country, $state = null, $provinc if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -614,20 +592,19 @@ public function faxLineAreaCodeGetWithHttpInfo($country, $state = null, $provinc return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -644,11 +621,9 @@ public function faxLineAreaCodeGetWithHttpInfo($country, $state = null, $provinc return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -661,7 +636,6 @@ public function faxLineAreaCodeGetWithHttpInfo($country, $state = null, $provinc ); $e->setResponseObject($data); break; - } throw $e; } @@ -672,17 +646,17 @@ public function faxLineAreaCodeGetWithHttpInfo($country, $state = null, $provinc * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country (required) - * @param string $state Filter area codes by state (optional) - * @param string $province Filter area codes by province (optional) - * @param string $city Filter area codes by city (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAreaCodeGet. This method will eventually become unavailable */ - public function faxLineAreaCodeGetAsync($country, $state = null, $province = null, $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) + public function faxLineAreaCodeGetAsync(string $country, string $state = null, string $province = null, string $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) { return $this->faxLineAreaCodeGetAsyncWithHttpInfo($country, $state, $province, $city, $contentType) ->then( @@ -697,17 +671,17 @@ function ($response) { * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country (required) - * @param string $state Filter area codes by state (optional) - * @param string $province Filter area codes by province (optional) - * @param string $city Filter area codes by city (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAreaCodeGet. This method will eventually become unavailable */ - public function faxLineAreaCodeGetAsyncWithHttpInfo($country, $state = null, $province = null, $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) + public function faxLineAreaCodeGetAsyncWithHttpInfo(string $country, string $state = null, string $province = null, string $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse'; $request = $this->faxLineAreaCodeGetRequest($country, $state, $province, $city, $contentType); @@ -717,9 +691,9 @@ public function faxLineAreaCodeGetAsyncWithHttpInfo($country, $state = null, $pr ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -728,7 +702,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -742,7 +716,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -751,30 +725,25 @@ function ($exception) { /** * Create request for operation 'faxLineAreaCodeGet' * - * @param string $country Filter area codes by country (required) - * @param string $state Filter area codes by state (optional) - * @param string $province Filter area codes by province (optional) - * @param string $city Filter area codes by city (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineAreaCodeGet. This method will eventually become unavailable */ - public function faxLineAreaCodeGetRequest($country, $state = null, $province = null, $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) + public function faxLineAreaCodeGetRequest(string $country, string $state = null, string $province = null, string $city = null, string $contentType = self::contentTypes['faxLineAreaCodeGet'][0]) { - // verify the required parameter 'country' is set if ($country === null || (is_array($country) && count($country) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $country when calling faxLineAreaCodeGet' ); } - - - - $resourcePath = '/fax_line/area_codes'; $formParams = []; $queryParams = []; @@ -819,11 +788,8 @@ public function faxLineAreaCodeGetRequest($country, $state = null, $province = n false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -837,7 +803,7 @@ public function faxLineAreaCodeGetRequest($country, $state = null, $province = n foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -851,9 +817,8 @@ public function faxLineAreaCodeGetRequest($country, $state = null, $province = n } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -892,13 +857,13 @@ public function faxLineAreaCodeGetRequest($country, $state = null, $province = n * * Purchase Fax Line * - * @param \Dropbox\Sign\Model\FaxLineCreateRequest $fax_line_create_request fax_line_create_request (required) + * @param Model\FaxLineCreateRequest $fax_line_create_request fax_line_create_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FaxLineResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxLineCreate($fax_line_create_request) + public function faxLineCreate(Model\FaxLineCreateRequest $fax_line_create_request) { list($response) = $this->faxLineCreateWithHttpInfo($fax_line_create_request); return $response; @@ -909,15 +874,15 @@ public function faxLineCreate($fax_line_create_request) * * Purchase Fax Line * - * @param \Dropbox\Sign\Model\FaxLineCreateRequest $fax_line_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation + * @param Model\FaxLineCreateRequest $fax_line_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FaxLineResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineCreate. This method will eventually become unavailable */ - public function faxLineCreateWithHttpInfo($fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) + public function faxLineCreateWithHttpInfo(Model\FaxLineCreateRequest $fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) { $request = $this->faxLineCreateRequest($fax_line_create_request, $contentType); @@ -929,14 +894,14 @@ public function faxLineCreateWithHttpInfo($fax_line_create_request, string $cont } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -949,14 +914,14 @@ public function faxLineCreateWithHttpInfo($fax_line_create_request, string $cont sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -965,18 +930,17 @@ public function faxLineCreateWithHttpInfo($fax_line_create_request, string $cont if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FaxLineResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -993,20 +957,19 @@ public function faxLineCreateWithHttpInfo($fax_line_create_request, string $cont return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1023,11 +986,9 @@ public function faxLineCreateWithHttpInfo($fax_line_create_request, string $cont return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1040,7 +1001,6 @@ public function faxLineCreateWithHttpInfo($fax_line_create_request, string $cont ); $e->setResponseObject($data); break; - } throw $e; } @@ -1051,14 +1011,14 @@ public function faxLineCreateWithHttpInfo($fax_line_create_request, string $cont * * Purchase Fax Line * - * @param \Dropbox\Sign\Model\FaxLineCreateRequest $fax_line_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation + * @param Model\FaxLineCreateRequest $fax_line_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineCreate. This method will eventually become unavailable */ - public function faxLineCreateAsync($fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) + public function faxLineCreateAsync(Model\FaxLineCreateRequest $fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) { return $this->faxLineCreateAsyncWithHttpInfo($fax_line_create_request, $contentType) ->then( @@ -1073,14 +1033,14 @@ function ($response) { * * Purchase Fax Line * - * @param \Dropbox\Sign\Model\FaxLineCreateRequest $fax_line_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation + * @param Model\FaxLineCreateRequest $fax_line_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineCreate. This method will eventually become unavailable */ - public function faxLineCreateAsyncWithHttpInfo($fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) + public function faxLineCreateAsyncWithHttpInfo(Model\FaxLineCreateRequest $fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; $request = $this->faxLineCreateRequest($fax_line_create_request, $contentType); @@ -1090,9 +1050,9 @@ public function faxLineCreateAsyncWithHttpInfo($fax_line_create_request, string ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1101,7 +1061,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1115,7 +1075,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1124,24 +1084,22 @@ function ($exception) { /** * Create request for operation 'faxLineCreate' * - * @param \Dropbox\Sign\Model\FaxLineCreateRequest $fax_line_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation + * @param Model\FaxLineCreateRequest $fax_line_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineCreate. This method will eventually become unavailable */ - public function faxLineCreateRequest($fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) + public function faxLineCreateRequest(Model\FaxLineCreateRequest $fax_line_create_request, string $contentType = self::contentTypes['faxLineCreate'][0]) { - // verify the required parameter 'fax_line_create_request' is set if ($fax_line_create_request === null || (is_array($fax_line_create_request) && count($fax_line_create_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $fax_line_create_request when calling faxLineCreate' ); } - $resourcePath = '/fax_line/create'; $formParams = []; $queryParams = []; @@ -1155,11 +1113,8 @@ public function faxLineCreateRequest($fax_line_create_request, string $contentTy $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1167,7 +1122,7 @@ public function faxLineCreateRequest($fax_line_create_request, string $contentTy // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_line_create_request)); } else { $httpBody = $fax_line_create_request; @@ -1180,7 +1135,7 @@ public function faxLineCreateRequest($fax_line_create_request, string $contentTy foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1197,9 +1152,8 @@ public function faxLineCreateRequest($fax_line_create_request, string $contentTy $payloadHook('multipart', $multipartContents, $fax_line_create_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1238,13 +1192,12 @@ public function faxLineCreateRequest($fax_line_create_request, string $contentTy * * Delete Fax Line * - * @param \Dropbox\Sign\Model\FaxLineDeleteRequest $fax_line_delete_request fax_line_delete_request (required) + * @param Model\FaxLineDeleteRequest $fax_line_delete_request fax_line_delete_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return void + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxLineDelete($fax_line_delete_request) + public function faxLineDelete(Model\FaxLineDeleteRequest $fax_line_delete_request) { $this->faxLineDeleteWithHttpInfo($fax_line_delete_request); } @@ -1254,15 +1207,15 @@ public function faxLineDelete($fax_line_delete_request) * * Delete Fax Line * - * @param \Dropbox\Sign\Model\FaxLineDeleteRequest $fax_line_delete_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation + * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineDelete. This method will eventually become unavailable */ - public function faxLineDeleteWithHttpInfo($fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) + public function faxLineDeleteWithHttpInfo(Model\FaxLineDeleteRequest $fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) { $request = $this->faxLineDeleteRequest($fax_line_delete_request, $contentType); @@ -1274,14 +1227,14 @@ public function faxLineDeleteWithHttpInfo($fax_line_delete_request, string $cont } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1294,23 +1247,20 @@ public function faxLineDeleteWithHttpInfo($fax_line_delete_request, string $cont sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { - } throw $e; } @@ -1321,14 +1271,14 @@ public function faxLineDeleteWithHttpInfo($fax_line_delete_request, string $cont * * Delete Fax Line * - * @param \Dropbox\Sign\Model\FaxLineDeleteRequest $fax_line_delete_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation + * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineDelete. This method will eventually become unavailable */ - public function faxLineDeleteAsync($fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) + public function faxLineDeleteAsync(Model\FaxLineDeleteRequest $fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) { return $this->faxLineDeleteAsyncWithHttpInfo($fax_line_delete_request, $contentType) ->then( @@ -1343,14 +1293,14 @@ function ($response) { * * Delete Fax Line * - * @param \Dropbox\Sign\Model\FaxLineDeleteRequest $fax_line_delete_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation + * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineDelete. This method will eventually become unavailable */ - public function faxLineDeleteAsyncWithHttpInfo($fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) + public function faxLineDeleteAsyncWithHttpInfo(Model\FaxLineDeleteRequest $fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) { $returnType = ''; $request = $this->faxLineDeleteRequest($fax_line_delete_request, $contentType); @@ -1358,7 +1308,7 @@ public function faxLineDeleteAsyncWithHttpInfo($fax_line_delete_request, string return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) use ($returnType) { + function ($response) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -1372,7 +1322,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1381,24 +1331,22 @@ function ($exception) { /** * Create request for operation 'faxLineDelete' * - * @param \Dropbox\Sign\Model\FaxLineDeleteRequest $fax_line_delete_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation + * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineDelete. This method will eventually become unavailable */ - public function faxLineDeleteRequest($fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) + public function faxLineDeleteRequest(Model\FaxLineDeleteRequest $fax_line_delete_request, string $contentType = self::contentTypes['faxLineDelete'][0]) { - // verify the required parameter 'fax_line_delete_request' is set if ($fax_line_delete_request === null || (is_array($fax_line_delete_request) && count($fax_line_delete_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $fax_line_delete_request when calling faxLineDelete' ); } - $resourcePath = '/fax_line'; $formParams = []; $queryParams = []; @@ -1412,11 +1360,8 @@ public function faxLineDeleteRequest($fax_line_delete_request, string $contentTy $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1424,7 +1369,7 @@ public function faxLineDeleteRequest($fax_line_delete_request, string $contentTy // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_line_delete_request)); } else { $httpBody = $fax_line_delete_request; @@ -1437,7 +1382,7 @@ public function faxLineDeleteRequest($fax_line_delete_request, string $contentTy foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1454,9 +1399,8 @@ public function faxLineDeleteRequest($fax_line_delete_request, string $contentTy $payloadHook('multipart', $multipartContents, $fax_line_delete_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1495,13 +1439,13 @@ public function faxLineDeleteRequest($fax_line_delete_request, string $contentTy * * Get Fax Line * - * @param string $number The Fax Line number (required) + * @param string $number The Fax Line number (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FaxLineResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxLineGet($number) + public function faxLineGet(string $number) { list($response) = $this->faxLineGetWithHttpInfo($number); return $response; @@ -1512,15 +1456,15 @@ public function faxLineGet($number) * * Get Fax Line * - * @param string $number The Fax Line number (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation + * @param string $number The Fax Line number (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FaxLineResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineGet. This method will eventually become unavailable */ - public function faxLineGetWithHttpInfo($number, string $contentType = self::contentTypes['faxLineGet'][0]) + public function faxLineGetWithHttpInfo(string $number, string $contentType = self::contentTypes['faxLineGet'][0]) { $request = $this->faxLineGetRequest($number, $contentType); @@ -1532,14 +1476,14 @@ public function faxLineGetWithHttpInfo($number, string $contentType = self::cont } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1552,14 +1496,14 @@ public function faxLineGetWithHttpInfo($number, string $contentType = self::cont sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1568,18 +1512,17 @@ public function faxLineGetWithHttpInfo($number, string $contentType = self::cont if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FaxLineResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1596,20 +1539,19 @@ public function faxLineGetWithHttpInfo($number, string $contentType = self::cont return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1626,11 +1568,9 @@ public function faxLineGetWithHttpInfo($number, string $contentType = self::cont return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1643,7 +1583,6 @@ public function faxLineGetWithHttpInfo($number, string $contentType = self::cont ); $e->setResponseObject($data); break; - } throw $e; } @@ -1654,14 +1593,14 @@ public function faxLineGetWithHttpInfo($number, string $contentType = self::cont * * Get Fax Line * - * @param string $number The Fax Line number (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation + * @param string $number The Fax Line number (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineGet. This method will eventually become unavailable */ - public function faxLineGetAsync($number, string $contentType = self::contentTypes['faxLineGet'][0]) + public function faxLineGetAsync(string $number, string $contentType = self::contentTypes['faxLineGet'][0]) { return $this->faxLineGetAsyncWithHttpInfo($number, $contentType) ->then( @@ -1676,14 +1615,14 @@ function ($response) { * * Get Fax Line * - * @param string $number The Fax Line number (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation + * @param string $number The Fax Line number (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineGet. This method will eventually become unavailable */ - public function faxLineGetAsyncWithHttpInfo($number, string $contentType = self::contentTypes['faxLineGet'][0]) + public function faxLineGetAsyncWithHttpInfo(string $number, string $contentType = self::contentTypes['faxLineGet'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; $request = $this->faxLineGetRequest($number, $contentType); @@ -1693,9 +1632,9 @@ public function faxLineGetAsyncWithHttpInfo($number, string $contentType = self: ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1704,7 +1643,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1718,7 +1657,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1727,24 +1666,22 @@ function ($exception) { /** * Create request for operation 'faxLineGet' * - * @param string $number The Fax Line number (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation + * @param string $number The Fax Line number (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineGet. This method will eventually become unavailable */ - public function faxLineGetRequest($number, string $contentType = self::contentTypes['faxLineGet'][0]) + public function faxLineGetRequest(string $number, string $contentType = self::contentTypes['faxLineGet'][0]) { - // verify the required parameter 'number' is set if ($number === null || (is_array($number) && count($number) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $number when calling faxLineGet' ); } - $resourcePath = '/fax_line'; $formParams = []; $queryParams = []; @@ -1762,11 +1699,8 @@ public function faxLineGetRequest($number, string $contentType = self::contentTy true // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1780,7 +1714,7 @@ public function faxLineGetRequest($number, string $contentType = self::contentTy foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1794,9 +1728,8 @@ public function faxLineGetRequest($number, string $contentType = self::contentTy } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1835,16 +1768,16 @@ public function faxLineGetRequest($number, string $contentType = self::contentTy * * List Fax Lines * - * @param string $account_id Account ID (optional) - * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) + * @param string $account_id Account ID (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FaxLineListResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FaxLineListResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxLineList($account_id = null, $page = 1, $page_size = 20, $show_team_lines = null) + public function faxLineList(string $account_id = null, int $page = 1, int $page_size = 20, bool $show_team_lines = null) { list($response) = $this->faxLineListWithHttpInfo($account_id, $page, $page_size, $show_team_lines); return $response; @@ -1855,18 +1788,18 @@ public function faxLineList($account_id = null, $page = 1, $page_size = 20, $sho * * List Fax Lines * - * @param string $account_id Account ID (optional) - * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation + * @param string $account_id Account ID (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FaxLineListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FaxLineListResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineList. This method will eventually become unavailable */ - public function faxLineListWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) + public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, bool $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) { $request = $this->faxLineListRequest($account_id, $page, $page_size, $show_team_lines, $contentType); @@ -1878,14 +1811,14 @@ public function faxLineListWithHttpInfo($account_id = null, $page = 1, $page_siz } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1898,14 +1831,14 @@ public function faxLineListWithHttpInfo($account_id = null, $page = 1, $page_siz sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1914,18 +1847,17 @@ public function faxLineListWithHttpInfo($account_id = null, $page = 1, $page_siz if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineListResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FaxLineListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1942,20 +1874,19 @@ public function faxLineListWithHttpInfo($account_id = null, $page = 1, $page_siz return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineListResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FaxLineListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1972,11 +1903,9 @@ public function faxLineListWithHttpInfo($account_id = null, $page = 1, $page_siz return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1989,7 +1918,6 @@ public function faxLineListWithHttpInfo($account_id = null, $page = 1, $page_siz ); $e->setResponseObject($data); break; - } throw $e; } @@ -2000,17 +1928,17 @@ public function faxLineListWithHttpInfo($account_id = null, $page = 1, $page_siz * * List Fax Lines * - * @param string $account_id Account ID (optional) - * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation + * @param string $account_id Account ID (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineList. This method will eventually become unavailable */ - public function faxLineListAsync($account_id = null, $page = 1, $page_size = 20, $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) + public function faxLineListAsync(string $account_id = null, int $page = 1, int $page_size = 20, bool $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) { return $this->faxLineListAsyncWithHttpInfo($account_id, $page, $page_size, $show_team_lines, $contentType) ->then( @@ -2025,17 +1953,17 @@ function ($response) { * * List Fax Lines * - * @param string $account_id Account ID (optional) - * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation + * @param string $account_id Account ID (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineList. This method will eventually become unavailable */ - public function faxLineListAsyncWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) + public function faxLineListAsyncWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, bool $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineListResponse'; $request = $this->faxLineListRequest($account_id, $page, $page_size, $show_team_lines, $contentType); @@ -2045,9 +1973,9 @@ public function faxLineListAsyncWithHttpInfo($account_id = null, $page = 1, $pag ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2056,7 +1984,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2070,7 +1998,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2079,24 +2007,18 @@ function ($exception) { /** * Create request for operation 'faxLineList' * - * @param string $account_id Account ID (optional) - * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation + * @param string $account_id Account ID (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineList. This method will eventually become unavailable */ - public function faxLineListRequest($account_id = null, $page = 1, $page_size = 20, $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) + public function faxLineListRequest(string $account_id = null, int $page = 1, int $page_size = 20, bool $show_team_lines = null, string $contentType = self::contentTypes['faxLineList'][0]) { - - - - - - $resourcePath = '/fax_line/list'; $formParams = []; $queryParams = []; @@ -2141,11 +2063,8 @@ public function faxLineListRequest($account_id = null, $page = 1, $page_size = 2 false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -2159,7 +2078,7 @@ public function faxLineListRequest($account_id = null, $page = 1, $page_size = 2 foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2173,9 +2092,8 @@ public function faxLineListRequest($account_id = null, $page = 1, $page_size = 2 } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2214,13 +2132,13 @@ public function faxLineListRequest($account_id = null, $page = 1, $page_size = 2 * * Remove Fax Line Access * - * @param \Dropbox\Sign\Model\FaxLineRemoveUserRequest $fax_line_remove_user_request fax_line_remove_user_request (required) + * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request fax_line_remove_user_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FaxLineResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function faxLineRemoveUser($fax_line_remove_user_request) + public function faxLineRemoveUser(Model\FaxLineRemoveUserRequest $fax_line_remove_user_request) { list($response) = $this->faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request); return $response; @@ -2231,15 +2149,15 @@ public function faxLineRemoveUser($fax_line_remove_user_request) * * Remove Fax Line Access * - * @param \Dropbox\Sign\Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation + * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FaxLineResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FaxLineResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineRemoveUser. This method will eventually become unavailable */ - public function faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) + public function faxLineRemoveUserWithHttpInfo(Model\FaxLineRemoveUserRequest $fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) { $request = $this->faxLineRemoveUserRequest($fax_line_remove_user_request, $contentType); @@ -2251,14 +2169,14 @@ public function faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request, str } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -2271,14 +2189,14 @@ public function faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request, str sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2287,18 +2205,17 @@ public function faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request, str if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FaxLineResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FaxLineResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2315,20 +2232,19 @@ public function faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request, str return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxLineResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2345,11 +2261,9 @@ public function faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request, str return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2362,7 +2276,6 @@ public function faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request, str ); $e->setResponseObject($data); break; - } throw $e; } @@ -2373,14 +2286,14 @@ public function faxLineRemoveUserWithHttpInfo($fax_line_remove_user_request, str * * Remove Fax Line Access * - * @param \Dropbox\Sign\Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation + * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineRemoveUser. This method will eventually become unavailable */ - public function faxLineRemoveUserAsync($fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) + public function faxLineRemoveUserAsync(Model\FaxLineRemoveUserRequest $fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) { return $this->faxLineRemoveUserAsyncWithHttpInfo($fax_line_remove_user_request, $contentType) ->then( @@ -2395,14 +2308,14 @@ function ($response) { * * Remove Fax Line Access * - * @param \Dropbox\Sign\Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation + * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineRemoveUser. This method will eventually become unavailable */ - public function faxLineRemoveUserAsyncWithHttpInfo($fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) + public function faxLineRemoveUserAsyncWithHttpInfo(Model\FaxLineRemoveUserRequest $fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) { $returnType = '\Dropbox\Sign\Model\FaxLineResponse'; $request = $this->faxLineRemoveUserRequest($fax_line_remove_user_request, $contentType); @@ -2412,9 +2325,9 @@ public function faxLineRemoveUserAsyncWithHttpInfo($fax_line_remove_user_request ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2423,7 +2336,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2437,7 +2350,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2446,24 +2359,22 @@ function ($exception) { /** * Create request for operation 'faxLineRemoveUser' * - * @param \Dropbox\Sign\Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation + * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::faxLineRemoveUser. This method will eventually become unavailable */ - public function faxLineRemoveUserRequest($fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) + public function faxLineRemoveUserRequest(Model\FaxLineRemoveUserRequest $fax_line_remove_user_request, string $contentType = self::contentTypes['faxLineRemoveUser'][0]) { - // verify the required parameter 'fax_line_remove_user_request' is set if ($fax_line_remove_user_request === null || (is_array($fax_line_remove_user_request) && count($fax_line_remove_user_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $fax_line_remove_user_request when calling faxLineRemoveUser' ); } - $resourcePath = '/fax_line/remove_user'; $formParams = []; $queryParams = []; @@ -2477,11 +2388,8 @@ public function faxLineRemoveUserRequest($fax_line_remove_user_request, string $ $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -2489,7 +2397,7 @@ public function faxLineRemoveUserRequest($fax_line_remove_user_request, string $ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_line_remove_user_request)); } else { $httpBody = $fax_line_remove_user_request; @@ -2502,7 +2410,7 @@ public function faxLineRemoveUserRequest($fax_line_remove_user_request, string $ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2519,9 +2427,8 @@ public function faxLineRemoveUserRequest($fax_line_remove_user_request, string $ $payloadHook('multipart', $multipartContents, $fax_line_remove_user_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2558,8 +2465,8 @@ public function faxLineRemoveUserRequest($fax_line_remove_user_request, string $ /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -2567,7 +2474,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -2583,8 +2490,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -2594,9 +2501,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -2615,8 +2522,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/OAuthApi.php b/sdks/php/src/Api/OAuthApi.php index 52e7bd4fa..81468626d 100644 --- a/sdks/php/src/Api/OAuthApi.php +++ b/sdks/php/src/Api/OAuthApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,34 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; /** * OAuthApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class OAuthApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'oauthTokenGenerate' => [ 'application/json', @@ -86,16 +79,13 @@ class OAuthApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -109,7 +99,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -150,13 +140,13 @@ public function getResponse() * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param \Dropbox\Sign\Model\OAuthTokenGenerateRequest $o_auth_token_generate_request o_auth_token_generate_request (required) + * @param Model\OAuthTokenGenerateRequest $o_auth_token_generate_request o_auth_token_generate_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\OAuthTokenResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\OAuthTokenResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function oauthTokenGenerate($o_auth_token_generate_request) + public function oauthTokenGenerate(Model\OAuthTokenGenerateRequest $o_auth_token_generate_request) { list($response) = $this->oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request); return $response; @@ -171,17 +161,17 @@ public function oauthTokenGenerate($o_auth_token_generate_request) * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param \Dropbox\Sign\Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) - * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation + * @param Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) + * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\OAuthTokenResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\OAuthTokenResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenGenerate. This method will eventually become unavailable */ - public function oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) + public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) { $request = $this->oauthTokenGenerateRequest($o_auth_token_generate_request, $hostIndex, $variables, $contentType); @@ -193,14 +183,14 @@ public function oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request, ? } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -213,14 +203,14 @@ public function oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request, ? sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -229,18 +219,17 @@ public function oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request, ? if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\OAuthTokenResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\OAuthTokenResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -257,20 +246,19 @@ public function oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request, ? return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\OAuthTokenResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\OAuthTokenResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -287,11 +275,9 @@ public function oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request, ? return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -304,7 +290,6 @@ public function oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request, ? ); $e->setResponseObject($data); break; - } throw $e; } @@ -319,16 +304,16 @@ public function oauthTokenGenerateWithHttpInfo($o_auth_token_generate_request, ? * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param \Dropbox\Sign\Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) - * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation + * @param Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) + * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenGenerate. This method will eventually become unavailable */ - public function oauthTokenGenerateAsync($o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) + public function oauthTokenGenerateAsync(Model\OAuthTokenGenerateRequest $o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) { return $this->oauthTokenGenerateAsyncWithHttpInfo($o_auth_token_generate_request, $hostIndex, $variables, $contentType) ->then( @@ -347,16 +332,16 @@ function ($response) { * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param \Dropbox\Sign\Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) - * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation + * @param Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) + * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenGenerate. This method will eventually become unavailable */ - public function oauthTokenGenerateAsyncWithHttpInfo($o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) + public function oauthTokenGenerateAsyncWithHttpInfo(Model\OAuthTokenGenerateRequest $o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) { $returnType = '\Dropbox\Sign\Model\OAuthTokenResponse'; $request = $this->oauthTokenGenerateRequest($o_auth_token_generate_request, $hostIndex, $variables, $contentType); @@ -366,9 +351,9 @@ public function oauthTokenGenerateAsyncWithHttpInfo($o_auth_token_generate_reque ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -377,7 +362,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -391,7 +376,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -400,30 +385,28 @@ function ($exception) { /** * Create request for operation 'oauthTokenGenerate' * - * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. - * if needed, use the 'variables' parameter to pass variables to the host. + * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. + * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param \Dropbox\Sign\Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) - * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation + * @param Model\OAuthTokenGenerateRequest $o_auth_token_generate_request (required) + * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenGenerate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenGenerate. This method will eventually become unavailable */ - public function oauthTokenGenerateRequest($o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) + public function oauthTokenGenerateRequest(Model\OAuthTokenGenerateRequest $o_auth_token_generate_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenGenerate'][0]) { - // verify the required parameter 'o_auth_token_generate_request' is set if ($o_auth_token_generate_request === null || (is_array($o_auth_token_generate_request) && count($o_auth_token_generate_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $o_auth_token_generate_request when calling oauthTokenGenerate' ); } - $resourcePath = '/oauth/token'; $formParams = []; $queryParams = []; @@ -437,11 +420,8 @@ public function oauthTokenGenerateRequest($o_auth_token_generate_request, ?int $ $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -449,7 +429,7 @@ public function oauthTokenGenerateRequest($o_auth_token_generate_request, ?int $ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($o_auth_token_generate_request)); } else { $httpBody = $o_auth_token_generate_request; @@ -462,7 +442,7 @@ public function oauthTokenGenerateRequest($o_auth_token_generate_request, ?int $ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -479,9 +459,8 @@ public function oauthTokenGenerateRequest($o_auth_token_generate_request, ?int $ $payloadHook('multipart', $multipartContents, $o_auth_token_generate_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -489,7 +468,6 @@ public function oauthTokenGenerateRequest($o_auth_token_generate_request, ?int $ } } - $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); @@ -501,7 +479,7 @@ public function oauthTokenGenerateRequest($o_auth_token_generate_request, ?int $ $headers ); - # Preserve the original behavior of server indexing. + // Preserve the original behavior of server indexing. if ($hostIndex === null) { $hostIndex = $this->hostIndex; } @@ -509,7 +487,7 @@ public function oauthTokenGenerateRequest($o_auth_token_generate_request, ?int $ $hostSettings = $this->getHostSettingsForoauthTokenGenerate(); if ($hostIndex < 0 || $hostIndex >= count($hostSettings)) { - throw new \InvalidArgumentException("Invalid index {$hostIndex} when selecting the host. Must be less than ".count($hostSettings)); + throw new InvalidArgumentException("Invalid index {$hostIndex} when selecting the host. Must be less than " . count($hostSettings)); } $operationHost = Configuration::getHostString($hostSettings, $hostIndex, $variables); $query = ObjectSerializer::buildQuery($queryParams); @@ -530,9 +508,9 @@ protected function getHostSettingsForoauthTokenGenerate(): array { return [ [ - "url" => "https://app.hellosign.com", - "description" => "No description provided", - ] + 'url' => 'https://app.hellosign.com', + 'description' => 'No description provided', + ], ]; } @@ -545,13 +523,13 @@ protected function getHostSettingsForoauthTokenGenerate(): array * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param \Dropbox\Sign\Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request o_auth_token_refresh_request (required) + * @param Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request o_auth_token_refresh_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\OAuthTokenResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\OAuthTokenResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function oauthTokenRefresh($o_auth_token_refresh_request) + public function oauthTokenRefresh(Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request) { list($response) = $this->oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request); return $response; @@ -566,17 +544,17 @@ public function oauthTokenRefresh($o_auth_token_refresh_request) * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param \Dropbox\Sign\Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) - * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation + * @param Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) + * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\OAuthTokenResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\OAuthTokenResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenRefresh. This method will eventually become unavailable */ - public function oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) + public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) { $request = $this->oauthTokenRefreshRequest($o_auth_token_refresh_request, $hostIndex, $variables, $contentType); @@ -588,14 +566,14 @@ public function oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request, ?in } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -608,14 +586,14 @@ public function oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request, ?in sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -624,18 +602,17 @@ public function oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request, ?in if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\OAuthTokenResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\OAuthTokenResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -652,20 +629,19 @@ public function oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request, ?in return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\OAuthTokenResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\OAuthTokenResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -682,11 +658,9 @@ public function oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request, ?in return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -699,7 +673,6 @@ public function oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request, ?in ); $e->setResponseObject($data); break; - } throw $e; } @@ -714,16 +687,16 @@ public function oauthTokenRefreshWithHttpInfo($o_auth_token_refresh_request, ?in * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param \Dropbox\Sign\Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) - * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation + * @param Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) + * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenRefresh. This method will eventually become unavailable */ - public function oauthTokenRefreshAsync($o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) + public function oauthTokenRefreshAsync(Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) { return $this->oauthTokenRefreshAsyncWithHttpInfo($o_auth_token_refresh_request, $hostIndex, $variables, $contentType) ->then( @@ -742,16 +715,16 @@ function ($response) { * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param \Dropbox\Sign\Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) - * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation + * @param Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) + * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenRefresh. This method will eventually become unavailable */ - public function oauthTokenRefreshAsyncWithHttpInfo($o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) + public function oauthTokenRefreshAsyncWithHttpInfo(Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) { $returnType = '\Dropbox\Sign\Model\OAuthTokenResponse'; $request = $this->oauthTokenRefreshRequest($o_auth_token_refresh_request, $hostIndex, $variables, $contentType); @@ -761,9 +734,9 @@ public function oauthTokenRefreshAsyncWithHttpInfo($o_auth_token_refresh_request ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -772,7 +745,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -786,7 +759,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -795,30 +768,28 @@ function ($exception) { /** * Create request for operation 'oauthTokenRefresh' * - * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. - * if needed, use the 'variables' parameter to pass variables to the host. + * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. + * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com * - * @param \Dropbox\Sign\Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) - * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead - * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation + * @param Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request (required) + * @param int|null $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead + * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['oauthTokenRefresh'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::oauthTokenRefresh. This method will eventually become unavailable */ - public function oauthTokenRefreshRequest($o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) + public function oauthTokenRefreshRequest(Model\OAuthTokenRefreshRequest $o_auth_token_refresh_request, ?int $hostIndex = null, array $variables = [], string $contentType = self::contentTypes['oauthTokenRefresh'][0]) { - // verify the required parameter 'o_auth_token_refresh_request' is set if ($o_auth_token_refresh_request === null || (is_array($o_auth_token_refresh_request) && count($o_auth_token_refresh_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $o_auth_token_refresh_request when calling oauthTokenRefresh' ); } - $resourcePath = '/oauth/token?refresh'; $formParams = []; $queryParams = []; @@ -832,11 +803,8 @@ public function oauthTokenRefreshRequest($o_auth_token_refresh_request, ?int $ho $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -844,7 +812,7 @@ public function oauthTokenRefreshRequest($o_auth_token_refresh_request, ?int $ho // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($o_auth_token_refresh_request)); } else { $httpBody = $o_auth_token_refresh_request; @@ -857,7 +825,7 @@ public function oauthTokenRefreshRequest($o_auth_token_refresh_request, ?int $ho foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -874,9 +842,8 @@ public function oauthTokenRefreshRequest($o_auth_token_refresh_request, ?int $ho $payloadHook('multipart', $multipartContents, $o_auth_token_refresh_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -884,7 +851,6 @@ public function oauthTokenRefreshRequest($o_auth_token_refresh_request, ?int $ho } } - $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); @@ -896,7 +862,7 @@ public function oauthTokenRefreshRequest($o_auth_token_refresh_request, ?int $ho $headers ); - # Preserve the original behavior of server indexing. + // Preserve the original behavior of server indexing. if ($hostIndex === null) { $hostIndex = $this->hostIndex; } @@ -904,7 +870,7 @@ public function oauthTokenRefreshRequest($o_auth_token_refresh_request, ?int $ho $hostSettings = $this->getHostSettingsForoauthTokenRefresh(); if ($hostIndex < 0 || $hostIndex >= count($hostSettings)) { - throw new \InvalidArgumentException("Invalid index {$hostIndex} when selecting the host. Must be less than ".count($hostSettings)); + throw new InvalidArgumentException("Invalid index {$hostIndex} when selecting the host. Must be less than " . count($hostSettings)); } $operationHost = Configuration::getHostString($hostSettings, $hostIndex, $variables); $query = ObjectSerializer::buildQuery($queryParams); @@ -925,17 +891,17 @@ protected function getHostSettingsForoauthTokenRefresh(): array { return [ [ - "url" => "https://app.hellosign.com", - "description" => "No description provided", - ] + 'url' => 'https://app.hellosign.com', + 'description' => 'No description provided', + ], ]; } /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -943,7 +909,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -959,8 +925,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -970,9 +936,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -991,8 +957,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/ReportApi.php b/sdks/php/src/Api/ReportApi.php index 902907e37..987fc25fe 100644 --- a/sdks/php/src/Api/ReportApi.php +++ b/sdks/php/src/Api/ReportApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,34 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; /** * ReportApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class ReportApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'reportCreate' => [ 'application/json', @@ -83,16 +76,13 @@ class ReportApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -106,7 +96,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -143,13 +133,13 @@ public function getResponse() * * Create Report * - * @param \Dropbox\Sign\Model\ReportCreateRequest $report_create_request report_create_request (required) + * @param Model\ReportCreateRequest $report_create_request report_create_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\ReportCreateResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\ReportCreateResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function reportCreate($report_create_request) + public function reportCreate(Model\ReportCreateRequest $report_create_request) { list($response) = $this->reportCreateWithHttpInfo($report_create_request); return $response; @@ -160,15 +150,15 @@ public function reportCreate($report_create_request) * * Create Report * - * @param \Dropbox\Sign\Model\ReportCreateRequest $report_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation + * @param Model\ReportCreateRequest $report_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\ReportCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\ReportCreateResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::reportCreate. This method will eventually become unavailable */ - public function reportCreateWithHttpInfo($report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) + public function reportCreateWithHttpInfo(Model\ReportCreateRequest $report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) { $request = $this->reportCreateRequest($report_create_request, $contentType); @@ -180,14 +170,14 @@ public function reportCreateWithHttpInfo($report_create_request, string $content } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -200,14 +190,14 @@ public function reportCreateWithHttpInfo($report_create_request, string $content sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -216,18 +206,17 @@ public function reportCreateWithHttpInfo($report_create_request, string $content if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\ReportCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\ReportCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -244,20 +233,19 @@ public function reportCreateWithHttpInfo($report_create_request, string $content return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\ReportCreateResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\ReportCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -274,11 +262,9 @@ public function reportCreateWithHttpInfo($report_create_request, string $content return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -291,7 +277,6 @@ public function reportCreateWithHttpInfo($report_create_request, string $content ); $e->setResponseObject($data); break; - } throw $e; } @@ -302,14 +287,14 @@ public function reportCreateWithHttpInfo($report_create_request, string $content * * Create Report * - * @param \Dropbox\Sign\Model\ReportCreateRequest $report_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation + * @param Model\ReportCreateRequest $report_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::reportCreate. This method will eventually become unavailable */ - public function reportCreateAsync($report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) + public function reportCreateAsync(Model\ReportCreateRequest $report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) { return $this->reportCreateAsyncWithHttpInfo($report_create_request, $contentType) ->then( @@ -324,14 +309,14 @@ function ($response) { * * Create Report * - * @param \Dropbox\Sign\Model\ReportCreateRequest $report_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation + * @param Model\ReportCreateRequest $report_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::reportCreate. This method will eventually become unavailable */ - public function reportCreateAsyncWithHttpInfo($report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) + public function reportCreateAsyncWithHttpInfo(Model\ReportCreateRequest $report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) { $returnType = '\Dropbox\Sign\Model\ReportCreateResponse'; $request = $this->reportCreateRequest($report_create_request, $contentType); @@ -341,9 +326,9 @@ public function reportCreateAsyncWithHttpInfo($report_create_request, string $co ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -352,7 +337,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -366,7 +351,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -375,24 +360,22 @@ function ($exception) { /** * Create request for operation 'reportCreate' * - * @param \Dropbox\Sign\Model\ReportCreateRequest $report_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation + * @param Model\ReportCreateRequest $report_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::reportCreate. This method will eventually become unavailable */ - public function reportCreateRequest($report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) + public function reportCreateRequest(Model\ReportCreateRequest $report_create_request, string $contentType = self::contentTypes['reportCreate'][0]) { - // verify the required parameter 'report_create_request' is set if ($report_create_request === null || (is_array($report_create_request) && count($report_create_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $report_create_request when calling reportCreate' ); } - $resourcePath = '/report/create'; $formParams = []; $queryParams = []; @@ -406,11 +389,8 @@ public function reportCreateRequest($report_create_request, string $contentType $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -418,7 +398,7 @@ public function reportCreateRequest($report_create_request, string $contentType // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($report_create_request)); } else { $httpBody = $report_create_request; @@ -431,7 +411,7 @@ public function reportCreateRequest($report_create_request, string $contentType foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -448,9 +428,8 @@ public function reportCreateRequest($report_create_request, string $contentType $payloadHook('multipart', $multipartContents, $report_create_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -487,8 +466,8 @@ public function reportCreateRequest($report_create_request, string $contentType /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -496,7 +475,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -512,8 +491,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -523,9 +502,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -544,8 +523,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/SignatureRequestApi.php b/sdks/php/src/Api/SignatureRequestApi.php index dc69531dd..e8da69d75 100644 --- a/sdks/php/src/Api/SignatureRequestApi.php +++ b/sdks/php/src/Api/SignatureRequestApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,35 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; +use SplFileObject; /** * SignatureRequestApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class SignatureRequestApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'signatureRequestBulkCreateEmbeddedWithTemplate' => [ 'application/json', @@ -134,16 +128,13 @@ class SignatureRequestApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -157,7 +148,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -194,13 +185,13 @@ public function getResponse() * * Embedded Bulk Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request signature_request_bulk_create_embedded_with_template_request (required) + * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request signature_request_bulk_create_embedded_with_template_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\BulkSendJobSendResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\BulkSendJobSendResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestBulkCreateEmbeddedWithTemplate($signature_request_bulk_create_embedded_with_template_request) + public function signatureRequestBulkCreateEmbeddedWithTemplate(Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request) { list($response) = $this->signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($signature_request_bulk_create_embedded_with_template_request); return $response; @@ -211,15 +202,15 @@ public function signatureRequestBulkCreateEmbeddedWithTemplate($signature_reques * * Embedded Bulk Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\BulkSendJobSendResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\BulkSendJobSendResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) + public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) { $request = $this->signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature_request_bulk_create_embedded_with_template_request, $contentType); @@ -231,14 +222,14 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($sign } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -251,14 +242,14 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($sign sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -267,18 +258,17 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($sign if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\BulkSendJobSendResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\BulkSendJobSendResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -295,20 +285,19 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($sign return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\BulkSendJobSendResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\BulkSendJobSendResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -325,11 +314,9 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($sign return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -342,7 +329,6 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($sign ); $e->setResponseObject($data); break; - } throw $e; } @@ -353,14 +339,14 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo($sign * * Embedded Bulk Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkCreateEmbeddedWithTemplateAsync($signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) + public function signatureRequestBulkCreateEmbeddedWithTemplateAsync(Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) { return $this->signatureRequestBulkCreateEmbeddedWithTemplateAsyncWithHttpInfo($signature_request_bulk_create_embedded_with_template_request, $contentType) ->then( @@ -375,14 +361,14 @@ function ($response) { * * Embedded Bulk Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkCreateEmbeddedWithTemplateAsyncWithHttpInfo($signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) + public function signatureRequestBulkCreateEmbeddedWithTemplateAsyncWithHttpInfo(Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) { $returnType = '\Dropbox\Sign\Model\BulkSendJobSendResponse'; $request = $this->signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature_request_bulk_create_embedded_with_template_request, $contentType); @@ -392,9 +378,9 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateAsyncWithHttpInfo( ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -403,7 +389,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -417,7 +403,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -426,24 +412,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestBulkCreateEmbeddedWithTemplate' * - * @param \Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) + public function signatureRequestBulkCreateEmbeddedWithTemplateRequest(Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'][0]) { - // verify the required parameter 'signature_request_bulk_create_embedded_with_template_request' is set if ($signature_request_bulk_create_embedded_with_template_request === null || (is_array($signature_request_bulk_create_embedded_with_template_request) && count($signature_request_bulk_create_embedded_with_template_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_bulk_create_embedded_with_template_request when calling signatureRequestBulkCreateEmbeddedWithTemplate' ); } - $resourcePath = '/signature_request/bulk_create_embedded_with_template'; $formParams = []; $queryParams = []; @@ -457,11 +441,8 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -469,7 +450,7 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_bulk_create_embedded_with_template_request)); } else { $httpBody = $signature_request_bulk_create_embedded_with_template_request; @@ -482,7 +463,7 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -499,9 +480,8 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature $payloadHook('multipart', $multipartContents, $signature_request_bulk_create_embedded_with_template_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -540,13 +520,13 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest($signature * * Bulk Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request signature_request_bulk_send_with_template_request (required) + * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request signature_request_bulk_send_with_template_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\BulkSendJobSendResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\BulkSendJobSendResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestBulkSendWithTemplate($signature_request_bulk_send_with_template_request) + public function signatureRequestBulkSendWithTemplate(Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request) { list($response) = $this->signatureRequestBulkSendWithTemplateWithHttpInfo($signature_request_bulk_send_with_template_request); return $response; @@ -557,15 +537,15 @@ public function signatureRequestBulkSendWithTemplate($signature_request_bulk_sen * * Bulk Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\BulkSendJobSendResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\BulkSendJobSendResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkSendWithTemplateWithHttpInfo($signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) + public function signatureRequestBulkSendWithTemplateWithHttpInfo(Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) { $request = $this->signatureRequestBulkSendWithTemplateRequest($signature_request_bulk_send_with_template_request, $contentType); @@ -577,14 +557,14 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo($signature_requ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -597,14 +577,14 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo($signature_requ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -613,18 +593,17 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo($signature_requ if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\BulkSendJobSendResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\BulkSendJobSendResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -641,20 +620,19 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo($signature_requ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\BulkSendJobSendResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\BulkSendJobSendResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -671,11 +649,9 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo($signature_requ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -688,7 +664,6 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo($signature_requ ); $e->setResponseObject($data); break; - } throw $e; } @@ -699,14 +674,14 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo($signature_requ * * Bulk Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkSendWithTemplateAsync($signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) + public function signatureRequestBulkSendWithTemplateAsync(Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) { return $this->signatureRequestBulkSendWithTemplateAsyncWithHttpInfo($signature_request_bulk_send_with_template_request, $contentType) ->then( @@ -721,14 +696,14 @@ function ($response) { * * Bulk Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkSendWithTemplateAsyncWithHttpInfo($signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) + public function signatureRequestBulkSendWithTemplateAsyncWithHttpInfo(Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) { $returnType = '\Dropbox\Sign\Model\BulkSendJobSendResponse'; $request = $this->signatureRequestBulkSendWithTemplateRequest($signature_request_bulk_send_with_template_request, $contentType); @@ -738,9 +713,9 @@ public function signatureRequestBulkSendWithTemplateAsyncWithHttpInfo($signature ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -749,7 +724,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -763,7 +738,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -772,24 +747,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestBulkSendWithTemplate' * - * @param \Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestBulkSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestBulkSendWithTemplateRequest($signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) + public function signatureRequestBulkSendWithTemplateRequest(Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request, string $contentType = self::contentTypes['signatureRequestBulkSendWithTemplate'][0]) { - // verify the required parameter 'signature_request_bulk_send_with_template_request' is set if ($signature_request_bulk_send_with_template_request === null || (is_array($signature_request_bulk_send_with_template_request) && count($signature_request_bulk_send_with_template_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_bulk_send_with_template_request when calling signatureRequestBulkSendWithTemplate' ); } - $resourcePath = '/signature_request/bulk_send_with_template'; $formParams = []; $queryParams = []; @@ -803,11 +776,8 @@ public function signatureRequestBulkSendWithTemplateRequest($signature_request_b $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -815,7 +785,7 @@ public function signatureRequestBulkSendWithTemplateRequest($signature_request_b // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_bulk_send_with_template_request)); } else { $httpBody = $signature_request_bulk_send_with_template_request; @@ -828,7 +798,7 @@ public function signatureRequestBulkSendWithTemplateRequest($signature_request_b foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -845,9 +815,8 @@ public function signatureRequestBulkSendWithTemplateRequest($signature_request_b $payloadHook('multipart', $multipartContents, $signature_request_bulk_send_with_template_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -890,13 +859,12 @@ public function signatureRequestBulkSendWithTemplateRequest($signature_request_b * * Cancel Incomplete Signature Request * - * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) + * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return void + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestCancel($signature_request_id) + public function signatureRequestCancel(string $signature_request_id) { $this->signatureRequestCancelWithHttpInfo($signature_request_id); } @@ -906,15 +874,15 @@ public function signatureRequestCancel($signature_request_id) * * Cancel Incomplete Signature Request * - * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation + * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCancel. This method will eventually become unavailable */ - public function signatureRequestCancelWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) + public function signatureRequestCancelWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) { $request = $this->signatureRequestCancelRequest($signature_request_id, $contentType); @@ -926,14 +894,14 @@ public function signatureRequestCancelWithHttpInfo($signature_request_id, string } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -946,23 +914,20 @@ public function signatureRequestCancelWithHttpInfo($signature_request_id, string sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { - } throw $e; } @@ -973,14 +938,14 @@ public function signatureRequestCancelWithHttpInfo($signature_request_id, string * * Cancel Incomplete Signature Request * - * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation + * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCancel. This method will eventually become unavailable */ - public function signatureRequestCancelAsync($signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) + public function signatureRequestCancelAsync(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) { return $this->signatureRequestCancelAsyncWithHttpInfo($signature_request_id, $contentType) ->then( @@ -995,14 +960,14 @@ function ($response) { * * Cancel Incomplete Signature Request * - * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation + * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCancel. This method will eventually become unavailable */ - public function signatureRequestCancelAsyncWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) + public function signatureRequestCancelAsyncWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) { $returnType = ''; $request = $this->signatureRequestCancelRequest($signature_request_id, $contentType); @@ -1010,7 +975,7 @@ public function signatureRequestCancelAsyncWithHttpInfo($signature_request_id, s return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) use ($returnType) { + function ($response) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -1024,7 +989,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1033,24 +998,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestCancel' * - * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation + * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCancel. This method will eventually become unavailable */ - public function signatureRequestCancelRequest($signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) + public function signatureRequestCancelRequest(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestCancel'][0]) { - // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestCancel' ); } - $resourcePath = '/signature_request/cancel/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -1058,20 +1021,17 @@ public function signatureRequestCancelRequest($signature_request_id, string $con $httpBody = ''; $multipart = false; - - // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{' . 'signature_request_id' . '}', + '{signature_request_id}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1085,7 +1045,7 @@ public function signatureRequestCancelRequest($signature_request_id, string $con foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1099,9 +1059,8 @@ public function signatureRequestCancelRequest($signature_request_id, string $con } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1144,13 +1103,13 @@ public function signatureRequestCancelRequest($signature_request_id, string $con * * Create Embedded Signature Request * - * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request signature_request_create_embedded_request (required) + * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request signature_request_create_embedded_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestCreateEmbedded($signature_request_create_embedded_request) + public function signatureRequestCreateEmbedded(Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request) { list($response) = $this->signatureRequestCreateEmbeddedWithHttpInfo($signature_request_create_embedded_request); return $response; @@ -1161,15 +1120,15 @@ public function signatureRequestCreateEmbedded($signature_request_create_embedde * * Create Embedded Signature Request * - * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation + * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbedded. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedWithHttpInfo($signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) + public function signatureRequestCreateEmbeddedWithHttpInfo(Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) { $request = $this->signatureRequestCreateEmbeddedRequest($signature_request_create_embedded_request, $contentType); @@ -1181,14 +1140,14 @@ public function signatureRequestCreateEmbeddedWithHttpInfo($signature_request_cr } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1201,14 +1160,14 @@ public function signatureRequestCreateEmbeddedWithHttpInfo($signature_request_cr sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1217,18 +1176,17 @@ public function signatureRequestCreateEmbeddedWithHttpInfo($signature_request_cr if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1245,20 +1203,19 @@ public function signatureRequestCreateEmbeddedWithHttpInfo($signature_request_cr return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1275,11 +1232,9 @@ public function signatureRequestCreateEmbeddedWithHttpInfo($signature_request_cr return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1292,7 +1247,6 @@ public function signatureRequestCreateEmbeddedWithHttpInfo($signature_request_cr ); $e->setResponseObject($data); break; - } throw $e; } @@ -1303,14 +1257,14 @@ public function signatureRequestCreateEmbeddedWithHttpInfo($signature_request_cr * * Create Embedded Signature Request * - * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation + * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbedded. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedAsync($signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) + public function signatureRequestCreateEmbeddedAsync(Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) { return $this->signatureRequestCreateEmbeddedAsyncWithHttpInfo($signature_request_create_embedded_request, $contentType) ->then( @@ -1325,14 +1279,14 @@ function ($response) { * * Create Embedded Signature Request * - * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation + * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbedded. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedAsyncWithHttpInfo($signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) + public function signatureRequestCreateEmbeddedAsyncWithHttpInfo(Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestCreateEmbeddedRequest($signature_request_create_embedded_request, $contentType); @@ -1342,9 +1296,9 @@ public function signatureRequestCreateEmbeddedAsyncWithHttpInfo($signature_reque ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1353,7 +1307,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1367,7 +1321,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1376,24 +1330,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestCreateEmbedded' * - * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation + * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbedded. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedRequest($signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) + public function signatureRequestCreateEmbeddedRequest(Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request, string $contentType = self::contentTypes['signatureRequestCreateEmbedded'][0]) { - // verify the required parameter 'signature_request_create_embedded_request' is set if ($signature_request_create_embedded_request === null || (is_array($signature_request_create_embedded_request) && count($signature_request_create_embedded_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_create_embedded_request when calling signatureRequestCreateEmbedded' ); } - $resourcePath = '/signature_request/create_embedded'; $formParams = []; $queryParams = []; @@ -1407,11 +1359,8 @@ public function signatureRequestCreateEmbeddedRequest($signature_request_create_ $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1419,7 +1368,7 @@ public function signatureRequestCreateEmbeddedRequest($signature_request_create_ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_create_embedded_request)); } else { $httpBody = $signature_request_create_embedded_request; @@ -1432,7 +1381,7 @@ public function signatureRequestCreateEmbeddedRequest($signature_request_create_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1449,9 +1398,8 @@ public function signatureRequestCreateEmbeddedRequest($signature_request_create_ $payloadHook('multipart', $multipartContents, $signature_request_create_embedded_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1494,13 +1442,13 @@ public function signatureRequestCreateEmbeddedRequest($signature_request_create_ * * Create Embedded Signature Request with Template * - * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request signature_request_create_embedded_with_template_request (required) + * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request signature_request_create_embedded_with_template_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestCreateEmbeddedWithTemplate($signature_request_create_embedded_with_template_request) + public function signatureRequestCreateEmbeddedWithTemplate(Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request) { list($response) = $this->signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signature_request_create_embedded_with_template_request); return $response; @@ -1511,15 +1459,15 @@ public function signatureRequestCreateEmbeddedWithTemplate($signature_request_cr * * Create Embedded Signature Request with Template * - * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) + public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) { $request = $this->signatureRequestCreateEmbeddedWithTemplateRequest($signature_request_create_embedded_with_template_request, $contentType); @@ -1531,14 +1479,14 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signatur } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1551,14 +1499,14 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signatur sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1567,18 +1515,17 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signatur if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1595,20 +1542,19 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signatur return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1625,11 +1571,9 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signatur return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1642,7 +1586,6 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signatur ); $e->setResponseObject($data); break; - } throw $e; } @@ -1653,14 +1596,14 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo($signatur * * Create Embedded Signature Request with Template * - * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedWithTemplateAsync($signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) + public function signatureRequestCreateEmbeddedWithTemplateAsync(Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) { return $this->signatureRequestCreateEmbeddedWithTemplateAsyncWithHttpInfo($signature_request_create_embedded_with_template_request, $contentType) ->then( @@ -1675,14 +1618,14 @@ function ($response) { * * Create Embedded Signature Request with Template * - * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedWithTemplateAsyncWithHttpInfo($signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) + public function signatureRequestCreateEmbeddedWithTemplateAsyncWithHttpInfo(Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestCreateEmbeddedWithTemplateRequest($signature_request_create_embedded_with_template_request, $contentType); @@ -1692,9 +1635,9 @@ public function signatureRequestCreateEmbeddedWithTemplateAsyncWithHttpInfo($sig ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1703,7 +1646,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1717,7 +1660,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1726,24 +1669,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestCreateEmbeddedWithTemplate' * - * @param \Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function signatureRequestCreateEmbeddedWithTemplateRequest($signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) + public function signatureRequestCreateEmbeddedWithTemplateRequest(Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'][0]) { - // verify the required parameter 'signature_request_create_embedded_with_template_request' is set if ($signature_request_create_embedded_with_template_request === null || (is_array($signature_request_create_embedded_with_template_request) && count($signature_request_create_embedded_with_template_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_create_embedded_with_template_request when calling signatureRequestCreateEmbeddedWithTemplate' ); } - $resourcePath = '/signature_request/create_embedded_with_template'; $formParams = []; $queryParams = []; @@ -1757,11 +1698,8 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest($signature_req $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1769,7 +1707,7 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest($signature_req // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_create_embedded_with_template_request)); } else { $httpBody = $signature_request_create_embedded_with_template_request; @@ -1782,7 +1720,7 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest($signature_req foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1799,9 +1737,8 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest($signature_req $payloadHook('multipart', $multipartContents, $signature_request_create_embedded_with_template_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1844,14 +1781,14 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest($signature_req * * Download Files * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \SplFileObject|\Dropbox\Sign\Model\ErrorResponse + * @return SplFileObject + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestFiles($signature_request_id, $file_type = 'pdf') + public function signatureRequestFiles(string $signature_request_id, string $file_type = 'pdf') { list($response) = $this->signatureRequestFilesWithHttpInfo($signature_request_id, $file_type); return $response; @@ -1862,16 +1799,16 @@ public function signatureRequestFiles($signature_request_id, $file_type = 'pdf') * * Download Files * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException * @return array of \SplFileObject|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFiles. This method will eventually become unavailable */ - public function signatureRequestFilesWithHttpInfo($signature_request_id, $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) + public function signatureRequestFilesWithHttpInfo(string $signature_request_id, string $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) { $request = $this->signatureRequestFilesRequest($signature_request_id, $file_type, $contentType); @@ -1883,14 +1820,14 @@ public function signatureRequestFilesWithHttpInfo($signature_request_id, $file_t } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1903,14 +1840,14 @@ public function signatureRequestFilesWithHttpInfo($signature_request_id, $file_t sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1919,18 +1856,17 @@ public function signatureRequestFilesWithHttpInfo($signature_request_id, $file_t if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\SplFileObject' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\SplFileObject' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1947,20 +1883,19 @@ public function signatureRequestFilesWithHttpInfo($signature_request_id, $file_t return [ ObjectSerializer::deserialize($content, '\SplFileObject', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\SplFileObject'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1977,11 +1912,9 @@ public function signatureRequestFilesWithHttpInfo($signature_request_id, $file_t return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1994,7 +1927,6 @@ public function signatureRequestFilesWithHttpInfo($signature_request_id, $file_t ); $e->setResponseObject($data); break; - } throw $e; } @@ -2005,15 +1937,15 @@ public function signatureRequestFilesWithHttpInfo($signature_request_id, $file_t * * Download Files * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFiles. This method will eventually become unavailable */ - public function signatureRequestFilesAsync($signature_request_id, $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) + public function signatureRequestFilesAsync(string $signature_request_id, string $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) { return $this->signatureRequestFilesAsyncWithHttpInfo($signature_request_id, $file_type, $contentType) ->then( @@ -2028,15 +1960,15 @@ function ($response) { * * Download Files * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFiles. This method will eventually become unavailable */ - public function signatureRequestFilesAsyncWithHttpInfo($signature_request_id, $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) + public function signatureRequestFilesAsyncWithHttpInfo(string $signature_request_id, string $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) { $returnType = '\SplFileObject'; $request = $this->signatureRequestFilesRequest($signature_request_id, $file_type, $contentType); @@ -2046,9 +1978,9 @@ public function signatureRequestFilesAsyncWithHttpInfo($signature_request_id, $f ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2057,7 +1989,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2071,7 +2003,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2080,26 +2012,23 @@ function ($exception) { /** * Create request for operation 'signatureRequestFiles' * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFiles. This method will eventually become unavailable */ - public function signatureRequestFilesRequest($signature_request_id, $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) + public function signatureRequestFilesRequest(string $signature_request_id, string $file_type = 'pdf', string $contentType = self::contentTypes['signatureRequestFiles'][0]) { - // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestFiles' ); } - - $resourcePath = '/signature_request/files/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -2117,19 +2046,17 @@ public function signatureRequestFilesRequest($signature_request_id, $file_type = false // required ) ?? []); - // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{' . 'signature_request_id' . '}', + '{signature_request_id}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/zip', 'application/json', ], + $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/zip', 'application/json'], $contentType, $multipart ); @@ -2143,7 +2070,7 @@ public function signatureRequestFilesRequest($signature_request_id, $file_type = foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2157,9 +2084,8 @@ public function signatureRequestFilesRequest($signature_request_id, $file_type = } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2202,13 +2128,13 @@ public function signatureRequestFilesRequest($signature_request_id, $file_type = * * Download Files as Data Uri * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FileResponseDataUri|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FileResponseDataUri + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestFilesAsDataUri($signature_request_id) + public function signatureRequestFilesAsDataUri(string $signature_request_id) { list($response) = $this->signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id); return $response; @@ -2219,15 +2145,15 @@ public function signatureRequestFilesAsDataUri($signature_request_id) * * Download Files as Data Uri * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FileResponseDataUri|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FileResponseDataUri, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsDataUri. This method will eventually become unavailable */ - public function signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) + public function signatureRequestFilesAsDataUriWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) { $request = $this->signatureRequestFilesAsDataUriRequest($signature_request_id, $contentType); @@ -2239,14 +2165,14 @@ public function signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -2259,14 +2185,14 @@ public function signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2275,18 +2201,17 @@ public function signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FileResponseDataUri' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FileResponseDataUri' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2303,20 +2228,19 @@ public function signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FileResponseDataUri', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FileResponseDataUri'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2333,11 +2257,9 @@ public function signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2350,7 +2272,6 @@ public function signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id ); $e->setResponseObject($data); break; - } throw $e; } @@ -2361,14 +2282,14 @@ public function signatureRequestFilesAsDataUriWithHttpInfo($signature_request_id * * Download Files as Data Uri * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsDataUri. This method will eventually become unavailable */ - public function signatureRequestFilesAsDataUriAsync($signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) + public function signatureRequestFilesAsDataUriAsync(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) { return $this->signatureRequestFilesAsDataUriAsyncWithHttpInfo($signature_request_id, $contentType) ->then( @@ -2383,14 +2304,14 @@ function ($response) { * * Download Files as Data Uri * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsDataUri. This method will eventually become unavailable */ - public function signatureRequestFilesAsDataUriAsyncWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) + public function signatureRequestFilesAsDataUriAsyncWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) { $returnType = '\Dropbox\Sign\Model\FileResponseDataUri'; $request = $this->signatureRequestFilesAsDataUriRequest($signature_request_id, $contentType); @@ -2400,9 +2321,9 @@ public function signatureRequestFilesAsDataUriAsyncWithHttpInfo($signature_reque ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2411,7 +2332,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2425,7 +2346,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2434,24 +2355,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestFilesAsDataUri' * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsDataUri. This method will eventually become unavailable */ - public function signatureRequestFilesAsDataUriRequest($signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) + public function signatureRequestFilesAsDataUriRequest(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestFilesAsDataUri'][0]) { - // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestFilesAsDataUri' ); } - $resourcePath = '/signature_request/files_as_data_uri/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -2459,20 +2378,17 @@ public function signatureRequestFilesAsDataUriRequest($signature_request_id, str $httpBody = ''; $multipart = false; - - // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{' . 'signature_request_id' . '}', + '{signature_request_id}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -2486,7 +2402,7 @@ public function signatureRequestFilesAsDataUriRequest($signature_request_id, str foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2500,9 +2416,8 @@ public function signatureRequestFilesAsDataUriRequest($signature_request_id, str } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2545,14 +2460,14 @@ public function signatureRequestFilesAsDataUriRequest($signature_request_id, str * * Download Files as File Url * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FileResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FileResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestFilesAsFileUrl($signature_request_id, $force_download = 1) + public function signatureRequestFilesAsFileUrl(string $signature_request_id, int $force_download = 1) { list($response) = $this->signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id, $force_download); return $response; @@ -2563,16 +2478,16 @@ public function signatureRequestFilesAsFileUrl($signature_request_id, $force_dow * * Download Files as File Url * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FileResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FileResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsFileUrl. This method will eventually become unavailable */ - public function signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id, $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) + public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_request_id, int $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) { $request = $this->signatureRequestFilesAsFileUrlRequest($signature_request_id, $force_download, $contentType); @@ -2584,14 +2499,14 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -2604,14 +2519,14 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2620,18 +2535,17 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FileResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FileResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2648,20 +2562,19 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FileResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FileResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2678,11 +2591,9 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2695,7 +2606,6 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id ); $e->setResponseObject($data); break; - } throw $e; } @@ -2706,15 +2616,15 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id * * Download Files as File Url * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsFileUrl. This method will eventually become unavailable */ - public function signatureRequestFilesAsFileUrlAsync($signature_request_id, $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) + public function signatureRequestFilesAsFileUrlAsync(string $signature_request_id, int $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) { return $this->signatureRequestFilesAsFileUrlAsyncWithHttpInfo($signature_request_id, $force_download, $contentType) ->then( @@ -2729,15 +2639,15 @@ function ($response) { * * Download Files as File Url * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsFileUrl. This method will eventually become unavailable */ - public function signatureRequestFilesAsFileUrlAsyncWithHttpInfo($signature_request_id, $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) + public function signatureRequestFilesAsFileUrlAsyncWithHttpInfo(string $signature_request_id, int $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) { $returnType = '\Dropbox\Sign\Model\FileResponse'; $request = $this->signatureRequestFilesAsFileUrlRequest($signature_request_id, $force_download, $contentType); @@ -2747,9 +2657,9 @@ public function signatureRequestFilesAsFileUrlAsyncWithHttpInfo($signature_reque ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2758,7 +2668,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2772,7 +2682,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2781,26 +2691,23 @@ function ($exception) { /** * Create request for operation 'signatureRequestFilesAsFileUrl' * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestFilesAsFileUrl. This method will eventually become unavailable */ - public function signatureRequestFilesAsFileUrlRequest($signature_request_id, $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) + public function signatureRequestFilesAsFileUrlRequest(string $signature_request_id, int $force_download = 1, string $contentType = self::contentTypes['signatureRequestFilesAsFileUrl'][0]) { - // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestFilesAsFileUrl' ); } - - $resourcePath = '/signature_request/files_as_file_url/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -2818,19 +2725,17 @@ public function signatureRequestFilesAsFileUrlRequest($signature_request_id, $fo false // required ) ?? []); - // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{' . 'signature_request_id' . '}', + '{signature_request_id}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -2844,7 +2749,7 @@ public function signatureRequestFilesAsFileUrlRequest($signature_request_id, $fo foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2858,9 +2763,8 @@ public function signatureRequestFilesAsFileUrlRequest($signature_request_id, $fo } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2903,13 +2807,13 @@ public function signatureRequestFilesAsFileUrlRequest($signature_request_id, $fo * * Get Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestGet($signature_request_id) + public function signatureRequestGet(string $signature_request_id) { list($response) = $this->signatureRequestGetWithHttpInfo($signature_request_id); return $response; @@ -2920,15 +2824,15 @@ public function signatureRequestGet($signature_request_id) * * Get Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestGet. This method will eventually become unavailable */ - public function signatureRequestGetWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) + public function signatureRequestGetWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) { $request = $this->signatureRequestGetRequest($signature_request_id, $contentType); @@ -2940,14 +2844,14 @@ public function signatureRequestGetWithHttpInfo($signature_request_id, string $c } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -2960,14 +2864,14 @@ public function signatureRequestGetWithHttpInfo($signature_request_id, string $c sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2976,18 +2880,17 @@ public function signatureRequestGetWithHttpInfo($signature_request_id, string $c if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3004,20 +2907,19 @@ public function signatureRequestGetWithHttpInfo($signature_request_id, string $c return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3034,11 +2936,9 @@ public function signatureRequestGetWithHttpInfo($signature_request_id, string $c return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3051,7 +2951,6 @@ public function signatureRequestGetWithHttpInfo($signature_request_id, string $c ); $e->setResponseObject($data); break; - } throw $e; } @@ -3062,14 +2961,14 @@ public function signatureRequestGetWithHttpInfo($signature_request_id, string $c * * Get Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestGet. This method will eventually become unavailable */ - public function signatureRequestGetAsync($signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) + public function signatureRequestGetAsync(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) { return $this->signatureRequestGetAsyncWithHttpInfo($signature_request_id, $contentType) ->then( @@ -3084,14 +2983,14 @@ function ($response) { * * Get Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestGet. This method will eventually become unavailable */ - public function signatureRequestGetAsyncWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) + public function signatureRequestGetAsyncWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestGetRequest($signature_request_id, $contentType); @@ -3101,9 +3000,9 @@ public function signatureRequestGetAsyncWithHttpInfo($signature_request_id, stri ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3112,7 +3011,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -3126,7 +3025,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -3135,24 +3034,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestGet' * - * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestGet. This method will eventually become unavailable */ - public function signatureRequestGetRequest($signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) + public function signatureRequestGetRequest(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestGet'][0]) { - // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestGet' ); } - $resourcePath = '/signature_request/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -3160,20 +3057,17 @@ public function signatureRequestGetRequest($signature_request_id, string $conten $httpBody = ''; $multipart = false; - - // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{' . 'signature_request_id' . '}', + '{signature_request_id}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -3187,7 +3081,7 @@ public function signatureRequestGetRequest($signature_request_id, string $conten foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -3201,9 +3095,8 @@ public function signatureRequestGetRequest($signature_request_id, string $conten } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3246,16 +3139,16 @@ public function signatureRequestGetRequest($signature_request_id, string $conten * * List Signature Requests * - * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) + * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\SignatureRequestListResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\SignatureRequestListResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestList($account_id = null, $page = 1, $page_size = 20, $query = null) + public function signatureRequestList(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null) { list($response) = $this->signatureRequestListWithHttpInfo($account_id, $page, $page_size, $query); return $response; @@ -3266,18 +3159,18 @@ public function signatureRequestList($account_id = null, $page = 1, $page_size = * * List Signature Requests * - * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation + * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\SignatureRequestListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\SignatureRequestListResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestList. This method will eventually become unavailable */ - public function signatureRequestListWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) + public function signatureRequestListWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) { $request = $this->signatureRequestListRequest($account_id, $page, $page_size, $query, $contentType); @@ -3289,14 +3182,14 @@ public function signatureRequestListWithHttpInfo($account_id = null, $page = 1, } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -3309,14 +3202,14 @@ public function signatureRequestListWithHttpInfo($account_id = null, $page = 1, sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3325,18 +3218,17 @@ public function signatureRequestListWithHttpInfo($account_id = null, $page = 1, if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestListResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3353,20 +3245,19 @@ public function signatureRequestListWithHttpInfo($account_id = null, $page = 1, return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestListResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\SignatureRequestListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3383,11 +3274,9 @@ public function signatureRequestListWithHttpInfo($account_id = null, $page = 1, return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3400,7 +3289,6 @@ public function signatureRequestListWithHttpInfo($account_id = null, $page = 1, ); $e->setResponseObject($data); break; - } throw $e; } @@ -3411,17 +3299,17 @@ public function signatureRequestListWithHttpInfo($account_id = null, $page = 1, * * List Signature Requests * - * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation + * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestList. This method will eventually become unavailable */ - public function signatureRequestListAsync($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) + public function signatureRequestListAsync(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) { return $this->signatureRequestListAsyncWithHttpInfo($account_id, $page, $page_size, $query, $contentType) ->then( @@ -3436,17 +3324,17 @@ function ($response) { * * List Signature Requests * - * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation + * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestList. This method will eventually become unavailable */ - public function signatureRequestListAsyncWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) + public function signatureRequestListAsyncWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestListResponse'; $request = $this->signatureRequestListRequest($account_id, $page, $page_size, $query, $contentType); @@ -3456,9 +3344,9 @@ public function signatureRequestListAsyncWithHttpInfo($account_id = null, $page ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3467,7 +3355,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -3481,7 +3369,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -3490,24 +3378,18 @@ function ($exception) { /** * Create request for operation 'signatureRequestList' * - * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation + * @param string $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestList'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestList. This method will eventually become unavailable */ - public function signatureRequestListRequest($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) + public function signatureRequestListRequest(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['signatureRequestList'][0]) { - - - - - - $resourcePath = '/signature_request/list'; $formParams = []; $queryParams = []; @@ -3552,11 +3434,8 @@ public function signatureRequestListRequest($account_id = null, $page = 1, $page false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -3570,7 +3449,7 @@ public function signatureRequestListRequest($account_id = null, $page = 1, $page foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -3584,9 +3463,8 @@ public function signatureRequestListRequest($account_id = null, $page = 1, $page } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3629,13 +3507,13 @@ public function signatureRequestListRequest($account_id = null, $page = 1, $page * * Release On-Hold Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to release. (required) + * @param string $signature_request_id The id of the SignatureRequest to release. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestReleaseHold($signature_request_id) + public function signatureRequestReleaseHold(string $signature_request_id) { list($response) = $this->signatureRequestReleaseHoldWithHttpInfo($signature_request_id); return $response; @@ -3646,15 +3524,15 @@ public function signatureRequestReleaseHold($signature_request_id) * * Release On-Hold Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to release. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to release. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestReleaseHold. This method will eventually become unavailable */ - public function signatureRequestReleaseHoldWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) + public function signatureRequestReleaseHoldWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) { $request = $this->signatureRequestReleaseHoldRequest($signature_request_id, $contentType); @@ -3666,14 +3544,14 @@ public function signatureRequestReleaseHoldWithHttpInfo($signature_request_id, s } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -3686,14 +3564,14 @@ public function signatureRequestReleaseHoldWithHttpInfo($signature_request_id, s sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3702,18 +3580,17 @@ public function signatureRequestReleaseHoldWithHttpInfo($signature_request_id, s if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3730,20 +3607,19 @@ public function signatureRequestReleaseHoldWithHttpInfo($signature_request_id, s return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3760,11 +3636,9 @@ public function signatureRequestReleaseHoldWithHttpInfo($signature_request_id, s return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3777,7 +3651,6 @@ public function signatureRequestReleaseHoldWithHttpInfo($signature_request_id, s ); $e->setResponseObject($data); break; - } throw $e; } @@ -3788,14 +3661,14 @@ public function signatureRequestReleaseHoldWithHttpInfo($signature_request_id, s * * Release On-Hold Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to release. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to release. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestReleaseHold. This method will eventually become unavailable */ - public function signatureRequestReleaseHoldAsync($signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) + public function signatureRequestReleaseHoldAsync(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) { return $this->signatureRequestReleaseHoldAsyncWithHttpInfo($signature_request_id, $contentType) ->then( @@ -3810,14 +3683,14 @@ function ($response) { * * Release On-Hold Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to release. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to release. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestReleaseHold. This method will eventually become unavailable */ - public function signatureRequestReleaseHoldAsyncWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) + public function signatureRequestReleaseHoldAsyncWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestReleaseHoldRequest($signature_request_id, $contentType); @@ -3827,9 +3700,9 @@ public function signatureRequestReleaseHoldAsyncWithHttpInfo($signature_request_ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3838,7 +3711,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -3852,7 +3725,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -3861,24 +3734,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestReleaseHold' * - * @param string $signature_request_id The id of the SignatureRequest to release. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to release. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestReleaseHold. This method will eventually become unavailable */ - public function signatureRequestReleaseHoldRequest($signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) + public function signatureRequestReleaseHoldRequest(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestReleaseHold'][0]) { - // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestReleaseHold' ); } - $resourcePath = '/signature_request/release_hold/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -3886,20 +3757,17 @@ public function signatureRequestReleaseHoldRequest($signature_request_id, string $httpBody = ''; $multipart = false; - - // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{' . 'signature_request_id' . '}', + '{signature_request_id}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -3913,7 +3781,7 @@ public function signatureRequestReleaseHoldRequest($signature_request_id, string foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -3927,9 +3795,8 @@ public function signatureRequestReleaseHoldRequest($signature_request_id, string } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3972,14 +3839,14 @@ public function signatureRequestReleaseHoldRequest($signature_request_id, string * * Send Request Reminder * - * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) - * @param \Dropbox\Sign\Model\SignatureRequestRemindRequest $signature_request_remind_request signature_request_remind_request (required) + * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) + * @param Model\SignatureRequestRemindRequest $signature_request_remind_request signature_request_remind_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestRemind($signature_request_id, $signature_request_remind_request) + public function signatureRequestRemind(string $signature_request_id, Model\SignatureRequestRemindRequest $signature_request_remind_request) { list($response) = $this->signatureRequestRemindWithHttpInfo($signature_request_id, $signature_request_remind_request); return $response; @@ -3990,16 +3857,16 @@ public function signatureRequestRemind($signature_request_id, $signature_request * * Send Request Reminder * - * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) - * @param \Dropbox\Sign\Model\SignatureRequestRemindRequest $signature_request_remind_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) + * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemind. This method will eventually become unavailable */ - public function signatureRequestRemindWithHttpInfo($signature_request_id, $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) + public function signatureRequestRemindWithHttpInfo(string $signature_request_id, Model\SignatureRequestRemindRequest $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) { $request = $this->signatureRequestRemindRequest($signature_request_id, $signature_request_remind_request, $contentType); @@ -4011,14 +3878,14 @@ public function signatureRequestRemindWithHttpInfo($signature_request_id, $signa } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -4031,14 +3898,14 @@ public function signatureRequestRemindWithHttpInfo($signature_request_id, $signa sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -4047,18 +3914,17 @@ public function signatureRequestRemindWithHttpInfo($signature_request_id, $signa if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -4075,20 +3941,19 @@ public function signatureRequestRemindWithHttpInfo($signature_request_id, $signa return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -4105,11 +3970,9 @@ public function signatureRequestRemindWithHttpInfo($signature_request_id, $signa return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -4122,7 +3985,6 @@ public function signatureRequestRemindWithHttpInfo($signature_request_id, $signa ); $e->setResponseObject($data); break; - } throw $e; } @@ -4133,15 +3995,15 @@ public function signatureRequestRemindWithHttpInfo($signature_request_id, $signa * * Send Request Reminder * - * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) - * @param \Dropbox\Sign\Model\SignatureRequestRemindRequest $signature_request_remind_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) + * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemind. This method will eventually become unavailable */ - public function signatureRequestRemindAsync($signature_request_id, $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) + public function signatureRequestRemindAsync(string $signature_request_id, Model\SignatureRequestRemindRequest $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) { return $this->signatureRequestRemindAsyncWithHttpInfo($signature_request_id, $signature_request_remind_request, $contentType) ->then( @@ -4156,15 +4018,15 @@ function ($response) { * * Send Request Reminder * - * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) - * @param \Dropbox\Sign\Model\SignatureRequestRemindRequest $signature_request_remind_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) + * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemind. This method will eventually become unavailable */ - public function signatureRequestRemindAsyncWithHttpInfo($signature_request_id, $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) + public function signatureRequestRemindAsyncWithHttpInfo(string $signature_request_id, Model\SignatureRequestRemindRequest $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestRemindRequest($signature_request_id, $signature_request_remind_request, $contentType); @@ -4174,9 +4036,9 @@ public function signatureRequestRemindAsyncWithHttpInfo($signature_request_id, $ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -4185,7 +4047,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -4199,7 +4061,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -4208,32 +4070,30 @@ function ($exception) { /** * Create request for operation 'signatureRequestRemind' * - * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) - * @param \Dropbox\Sign\Model\SignatureRequestRemindRequest $signature_request_remind_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) + * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemind. This method will eventually become unavailable */ - public function signatureRequestRemindRequest($signature_request_id, $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) + public function signatureRequestRemindRequest(string $signature_request_id, Model\SignatureRequestRemindRequest $signature_request_remind_request, string $contentType = self::contentTypes['signatureRequestRemind'][0]) { - // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestRemind' ); } // verify the required parameter 'signature_request_remind_request' is set if ($signature_request_remind_request === null || (is_array($signature_request_remind_request) && count($signature_request_remind_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_remind_request when calling signatureRequestRemind' ); } - $resourcePath = '/signature_request/remind/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -4247,19 +4107,17 @@ public function signatureRequestRemindRequest($signature_request_id, $signature_ $multipart = !empty($formParams); - // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{' . 'signature_request_id' . '}', + '{signature_request_id}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -4267,7 +4125,7 @@ public function signatureRequestRemindRequest($signature_request_id, $signature_ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_remind_request)); } else { $httpBody = $signature_request_remind_request; @@ -4280,7 +4138,7 @@ public function signatureRequestRemindRequest($signature_request_id, $signature_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -4297,9 +4155,8 @@ public function signatureRequestRemindRequest($signature_request_id, $signature_ $payloadHook('multipart', $multipartContents, $signature_request_remind_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -4342,13 +4199,12 @@ public function signatureRequestRemindRequest($signature_request_id, $signature_ * * Remove Signature Request Access * - * @param string $signature_request_id The id of the SignatureRequest to remove. (required) + * @param string $signature_request_id The id of the SignatureRequest to remove. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return void + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestRemove($signature_request_id) + public function signatureRequestRemove(string $signature_request_id) { $this->signatureRequestRemoveWithHttpInfo($signature_request_id); } @@ -4358,15 +4214,15 @@ public function signatureRequestRemove($signature_request_id) * * Remove Signature Request Access * - * @param string $signature_request_id The id of the SignatureRequest to remove. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to remove. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemove. This method will eventually become unavailable */ - public function signatureRequestRemoveWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) + public function signatureRequestRemoveWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) { $request = $this->signatureRequestRemoveRequest($signature_request_id, $contentType); @@ -4378,14 +4234,14 @@ public function signatureRequestRemoveWithHttpInfo($signature_request_id, string } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -4398,23 +4254,20 @@ public function signatureRequestRemoveWithHttpInfo($signature_request_id, string sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { - } throw $e; } @@ -4425,14 +4278,14 @@ public function signatureRequestRemoveWithHttpInfo($signature_request_id, string * * Remove Signature Request Access * - * @param string $signature_request_id The id of the SignatureRequest to remove. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to remove. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemove. This method will eventually become unavailable */ - public function signatureRequestRemoveAsync($signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) + public function signatureRequestRemoveAsync(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) { return $this->signatureRequestRemoveAsyncWithHttpInfo($signature_request_id, $contentType) ->then( @@ -4447,14 +4300,14 @@ function ($response) { * * Remove Signature Request Access * - * @param string $signature_request_id The id of the SignatureRequest to remove. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to remove. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemove. This method will eventually become unavailable */ - public function signatureRequestRemoveAsyncWithHttpInfo($signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) + public function signatureRequestRemoveAsyncWithHttpInfo(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) { $returnType = ''; $request = $this->signatureRequestRemoveRequest($signature_request_id, $contentType); @@ -4462,7 +4315,7 @@ public function signatureRequestRemoveAsyncWithHttpInfo($signature_request_id, s return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) use ($returnType) { + function ($response) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -4476,7 +4329,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -4485,24 +4338,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestRemove' * - * @param string $signature_request_id The id of the SignatureRequest to remove. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to remove. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestRemove. This method will eventually become unavailable */ - public function signatureRequestRemoveRequest($signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) + public function signatureRequestRemoveRequest(string $signature_request_id, string $contentType = self::contentTypes['signatureRequestRemove'][0]) { - // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestRemove' ); } - $resourcePath = '/signature_request/remove/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -4510,20 +4361,17 @@ public function signatureRequestRemoveRequest($signature_request_id, string $con $httpBody = ''; $multipart = false; - - // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{' . 'signature_request_id' . '}', + '{signature_request_id}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -4537,7 +4385,7 @@ public function signatureRequestRemoveRequest($signature_request_id, string $con foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -4551,9 +4399,8 @@ public function signatureRequestRemoveRequest($signature_request_id, string $con } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -4592,13 +4439,13 @@ public function signatureRequestRemoveRequest($signature_request_id, string $con * * Send Signature Request * - * @param \Dropbox\Sign\Model\SignatureRequestSendRequest $signature_request_send_request signature_request_send_request (required) + * @param Model\SignatureRequestSendRequest $signature_request_send_request signature_request_send_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestSend($signature_request_send_request) + public function signatureRequestSend(Model\SignatureRequestSendRequest $signature_request_send_request) { list($response) = $this->signatureRequestSendWithHttpInfo($signature_request_send_request); return $response; @@ -4609,15 +4456,15 @@ public function signatureRequestSend($signature_request_send_request) * * Send Signature Request * - * @param \Dropbox\Sign\Model\SignatureRequestSendRequest $signature_request_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation + * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSend. This method will eventually become unavailable */ - public function signatureRequestSendWithHttpInfo($signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) + public function signatureRequestSendWithHttpInfo(Model\SignatureRequestSendRequest $signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) { $request = $this->signatureRequestSendRequest($signature_request_send_request, $contentType); @@ -4629,14 +4476,14 @@ public function signatureRequestSendWithHttpInfo($signature_request_send_request } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -4649,14 +4496,14 @@ public function signatureRequestSendWithHttpInfo($signature_request_send_request sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -4665,18 +4512,17 @@ public function signatureRequestSendWithHttpInfo($signature_request_send_request if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -4693,20 +4539,19 @@ public function signatureRequestSendWithHttpInfo($signature_request_send_request return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -4723,11 +4568,9 @@ public function signatureRequestSendWithHttpInfo($signature_request_send_request return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -4740,7 +4583,6 @@ public function signatureRequestSendWithHttpInfo($signature_request_send_request ); $e->setResponseObject($data); break; - } throw $e; } @@ -4751,14 +4593,14 @@ public function signatureRequestSendWithHttpInfo($signature_request_send_request * * Send Signature Request * - * @param \Dropbox\Sign\Model\SignatureRequestSendRequest $signature_request_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation + * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSend. This method will eventually become unavailable */ - public function signatureRequestSendAsync($signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) + public function signatureRequestSendAsync(Model\SignatureRequestSendRequest $signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) { return $this->signatureRequestSendAsyncWithHttpInfo($signature_request_send_request, $contentType) ->then( @@ -4773,14 +4615,14 @@ function ($response) { * * Send Signature Request * - * @param \Dropbox\Sign\Model\SignatureRequestSendRequest $signature_request_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation + * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSend. This method will eventually become unavailable */ - public function signatureRequestSendAsyncWithHttpInfo($signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) + public function signatureRequestSendAsyncWithHttpInfo(Model\SignatureRequestSendRequest $signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestSendRequest($signature_request_send_request, $contentType); @@ -4790,9 +4632,9 @@ public function signatureRequestSendAsyncWithHttpInfo($signature_request_send_re ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -4801,7 +4643,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -4815,7 +4657,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -4824,24 +4666,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestSend' * - * @param \Dropbox\Sign\Model\SignatureRequestSendRequest $signature_request_send_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation + * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSend. This method will eventually become unavailable */ - public function signatureRequestSendRequest($signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) + public function signatureRequestSendRequest(Model\SignatureRequestSendRequest $signature_request_send_request, string $contentType = self::contentTypes['signatureRequestSend'][0]) { - // verify the required parameter 'signature_request_send_request' is set if ($signature_request_send_request === null || (is_array($signature_request_send_request) && count($signature_request_send_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_send_request when calling signatureRequestSend' ); } - $resourcePath = '/signature_request/send'; $formParams = []; $queryParams = []; @@ -4855,11 +4695,8 @@ public function signatureRequestSendRequest($signature_request_send_request, str $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -4867,7 +4704,7 @@ public function signatureRequestSendRequest($signature_request_send_request, str // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_send_request)); } else { $httpBody = $signature_request_send_request; @@ -4880,7 +4717,7 @@ public function signatureRequestSendRequest($signature_request_send_request, str foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -4897,9 +4734,8 @@ public function signatureRequestSendRequest($signature_request_send_request, str $payloadHook('multipart', $multipartContents, $signature_request_send_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -4942,13 +4778,13 @@ public function signatureRequestSendRequest($signature_request_send_request, str * * Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request signature_request_send_with_template_request (required) + * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request signature_request_send_with_template_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestSendWithTemplate($signature_request_send_with_template_request) + public function signatureRequestSendWithTemplate(Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request) { list($response) = $this->signatureRequestSendWithTemplateWithHttpInfo($signature_request_send_with_template_request); return $response; @@ -4959,15 +4795,15 @@ public function signatureRequestSendWithTemplate($signature_request_send_with_te * * Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestSendWithTemplateWithHttpInfo($signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) + public function signatureRequestSendWithTemplateWithHttpInfo(Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) { $request = $this->signatureRequestSendWithTemplateRequest($signature_request_send_with_template_request, $contentType); @@ -4979,14 +4815,14 @@ public function signatureRequestSendWithTemplateWithHttpInfo($signature_request_ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -4999,14 +4835,14 @@ public function signatureRequestSendWithTemplateWithHttpInfo($signature_request_ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -5015,18 +4851,17 @@ public function signatureRequestSendWithTemplateWithHttpInfo($signature_request_ if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -5043,20 +4878,19 @@ public function signatureRequestSendWithTemplateWithHttpInfo($signature_request_ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -5073,11 +4907,9 @@ public function signatureRequestSendWithTemplateWithHttpInfo($signature_request_ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -5090,7 +4922,6 @@ public function signatureRequestSendWithTemplateWithHttpInfo($signature_request_ ); $e->setResponseObject($data); break; - } throw $e; } @@ -5101,14 +4932,14 @@ public function signatureRequestSendWithTemplateWithHttpInfo($signature_request_ * * Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestSendWithTemplateAsync($signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) + public function signatureRequestSendWithTemplateAsync(Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) { return $this->signatureRequestSendWithTemplateAsyncWithHttpInfo($signature_request_send_with_template_request, $contentType) ->then( @@ -5123,14 +4954,14 @@ function ($response) { * * Send with Template * - * @param \Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestSendWithTemplateAsyncWithHttpInfo($signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) + public function signatureRequestSendWithTemplateAsyncWithHttpInfo(Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestSendWithTemplateRequest($signature_request_send_with_template_request, $contentType); @@ -5140,9 +4971,9 @@ public function signatureRequestSendWithTemplateAsyncWithHttpInfo($signature_req ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -5151,7 +4982,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -5165,7 +4996,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -5174,24 +5005,22 @@ function ($exception) { /** * Create request for operation 'signatureRequestSendWithTemplate' * - * @param \Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation + * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestSendWithTemplate. This method will eventually become unavailable */ - public function signatureRequestSendWithTemplateRequest($signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) + public function signatureRequestSendWithTemplateRequest(Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request, string $contentType = self::contentTypes['signatureRequestSendWithTemplate'][0]) { - // verify the required parameter 'signature_request_send_with_template_request' is set if ($signature_request_send_with_template_request === null || (is_array($signature_request_send_with_template_request) && count($signature_request_send_with_template_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_send_with_template_request when calling signatureRequestSendWithTemplate' ); } - $resourcePath = '/signature_request/send_with_template'; $formParams = []; $queryParams = []; @@ -5205,11 +5034,8 @@ public function signatureRequestSendWithTemplateRequest($signature_request_send_ $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -5217,7 +5043,7 @@ public function signatureRequestSendWithTemplateRequest($signature_request_send_ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_send_with_template_request)); } else { $httpBody = $signature_request_send_with_template_request; @@ -5230,7 +5056,7 @@ public function signatureRequestSendWithTemplateRequest($signature_request_send_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -5247,9 +5073,8 @@ public function signatureRequestSendWithTemplateRequest($signature_request_send_ $payloadHook('multipart', $multipartContents, $signature_request_send_with_template_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -5292,14 +5117,14 @@ public function signatureRequestSendWithTemplateRequest($signature_request_send_ * * Update Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to update. (required) - * @param \Dropbox\Sign\Model\SignatureRequestUpdateRequest $signature_request_update_request signature_request_update_request (required) + * @param string $signature_request_id The id of the SignatureRequest to update. (required) + * @param Model\SignatureRequestUpdateRequest $signature_request_update_request signature_request_update_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function signatureRequestUpdate($signature_request_id, $signature_request_update_request) + public function signatureRequestUpdate(string $signature_request_id, Model\SignatureRequestUpdateRequest $signature_request_update_request) { list($response) = $this->signatureRequestUpdateWithHttpInfo($signature_request_id, $signature_request_update_request); return $response; @@ -5310,16 +5135,16 @@ public function signatureRequestUpdate($signature_request_id, $signature_request * * Update Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to update. (required) - * @param \Dropbox\Sign\Model\SignatureRequestUpdateRequest $signature_request_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to update. (required) + * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\SignatureRequestGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestUpdate. This method will eventually become unavailable */ - public function signatureRequestUpdateWithHttpInfo($signature_request_id, $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) + public function signatureRequestUpdateWithHttpInfo(string $signature_request_id, Model\SignatureRequestUpdateRequest $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) { $request = $this->signatureRequestUpdateRequest($signature_request_id, $signature_request_update_request, $contentType); @@ -5331,14 +5156,14 @@ public function signatureRequestUpdateWithHttpInfo($signature_request_id, $signa } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -5351,14 +5176,14 @@ public function signatureRequestUpdateWithHttpInfo($signature_request_id, $signa sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -5367,18 +5192,17 @@ public function signatureRequestUpdateWithHttpInfo($signature_request_id, $signa if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -5395,20 +5219,19 @@ public function signatureRequestUpdateWithHttpInfo($signature_request_id, $signa return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -5425,11 +5248,9 @@ public function signatureRequestUpdateWithHttpInfo($signature_request_id, $signa return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -5442,7 +5263,6 @@ public function signatureRequestUpdateWithHttpInfo($signature_request_id, $signa ); $e->setResponseObject($data); break; - } throw $e; } @@ -5453,15 +5273,15 @@ public function signatureRequestUpdateWithHttpInfo($signature_request_id, $signa * * Update Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to update. (required) - * @param \Dropbox\Sign\Model\SignatureRequestUpdateRequest $signature_request_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to update. (required) + * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestUpdate. This method will eventually become unavailable */ - public function signatureRequestUpdateAsync($signature_request_id, $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) + public function signatureRequestUpdateAsync(string $signature_request_id, Model\SignatureRequestUpdateRequest $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) { return $this->signatureRequestUpdateAsyncWithHttpInfo($signature_request_id, $signature_request_update_request, $contentType) ->then( @@ -5476,15 +5296,15 @@ function ($response) { * * Update Signature Request * - * @param string $signature_request_id The id of the SignatureRequest to update. (required) - * @param \Dropbox\Sign\Model\SignatureRequestUpdateRequest $signature_request_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to update. (required) + * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestUpdate. This method will eventually become unavailable */ - public function signatureRequestUpdateAsyncWithHttpInfo($signature_request_id, $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) + public function signatureRequestUpdateAsyncWithHttpInfo(string $signature_request_id, Model\SignatureRequestUpdateRequest $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) { $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; $request = $this->signatureRequestUpdateRequest($signature_request_id, $signature_request_update_request, $contentType); @@ -5494,9 +5314,9 @@ public function signatureRequestUpdateAsyncWithHttpInfo($signature_request_id, $ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -5505,7 +5325,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -5519,7 +5339,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -5528,32 +5348,30 @@ function ($exception) { /** * Create request for operation 'signatureRequestUpdate' * - * @param string $signature_request_id The id of the SignatureRequest to update. (required) - * @param \Dropbox\Sign\Model\SignatureRequestUpdateRequest $signature_request_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation + * @param string $signature_request_id The id of the SignatureRequest to update. (required) + * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::signatureRequestUpdate. This method will eventually become unavailable */ - public function signatureRequestUpdateRequest($signature_request_id, $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) + public function signatureRequestUpdateRequest(string $signature_request_id, Model\SignatureRequestUpdateRequest $signature_request_update_request, string $contentType = self::contentTypes['signatureRequestUpdate'][0]) { - // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling signatureRequestUpdate' ); } // verify the required parameter 'signature_request_update_request' is set if ($signature_request_update_request === null || (is_array($signature_request_update_request) && count($signature_request_update_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_update_request when calling signatureRequestUpdate' ); } - $resourcePath = '/signature_request/update/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -5567,19 +5385,17 @@ public function signatureRequestUpdateRequest($signature_request_id, $signature_ $multipart = !empty($formParams); - // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{' . 'signature_request_id' . '}', + '{signature_request_id}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -5587,7 +5403,7 @@ public function signatureRequestUpdateRequest($signature_request_id, $signature_ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_update_request)); } else { $httpBody = $signature_request_update_request; @@ -5600,7 +5416,7 @@ public function signatureRequestUpdateRequest($signature_request_id, $signature_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -5617,9 +5433,8 @@ public function signatureRequestUpdateRequest($signature_request_id, $signature_ $payloadHook('multipart', $multipartContents, $signature_request_update_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -5660,8 +5475,8 @@ public function signatureRequestUpdateRequest($signature_request_id, $signature_ /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -5669,7 +5484,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -5685,8 +5500,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -5696,9 +5511,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -5717,8 +5532,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/TeamApi.php b/sdks/php/src/Api/TeamApi.php index 653db9fdb..ec599b4ac 100644 --- a/sdks/php/src/Api/TeamApi.php +++ b/sdks/php/src/Api/TeamApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,34 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; /** * TeamApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class TeamApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'teamAddMember' => [ 'application/json', @@ -110,16 +103,13 @@ class TeamApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -133,7 +123,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -170,14 +160,14 @@ public function getResponse() * * Add User to Team * - * @param \Dropbox\Sign\Model\TeamAddMemberRequest $team_add_member_request team_add_member_request (required) - * @param string $team_id The id of the team. (optional) + * @param Model\TeamAddMemberRequest $team_add_member_request team_add_member_request (required) + * @param string $team_id The id of the team. (optional) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TeamGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function teamAddMember($team_add_member_request, $team_id = null) + public function teamAddMember(Model\TeamAddMemberRequest $team_add_member_request, string $team_id = null) { list($response) = $this->teamAddMemberWithHttpInfo($team_add_member_request, $team_id); return $response; @@ -188,16 +178,16 @@ public function teamAddMember($team_add_member_request, $team_id = null) * * Add User to Team * - * @param \Dropbox\Sign\Model\TeamAddMemberRequest $team_add_member_request (required) - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation + * @param Model\TeamAddMemberRequest $team_add_member_request (required) + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamAddMember. This method will eventually become unavailable */ - public function teamAddMemberWithHttpInfo($team_add_member_request, $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) + public function teamAddMemberWithHttpInfo(Model\TeamAddMemberRequest $team_add_member_request, string $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) { $request = $this->teamAddMemberRequest($team_add_member_request, $team_id, $contentType); @@ -209,14 +199,14 @@ public function teamAddMemberWithHttpInfo($team_add_member_request, $team_id = n } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -229,14 +219,14 @@ public function teamAddMemberWithHttpInfo($team_add_member_request, $team_id = n sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -245,18 +235,17 @@ public function teamAddMemberWithHttpInfo($team_add_member_request, $team_id = n if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TeamGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -273,20 +262,19 @@ public function teamAddMemberWithHttpInfo($team_add_member_request, $team_id = n return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -303,11 +291,9 @@ public function teamAddMemberWithHttpInfo($team_add_member_request, $team_id = n return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -320,7 +306,6 @@ public function teamAddMemberWithHttpInfo($team_add_member_request, $team_id = n ); $e->setResponseObject($data); break; - } throw $e; } @@ -331,15 +316,15 @@ public function teamAddMemberWithHttpInfo($team_add_member_request, $team_id = n * * Add User to Team * - * @param \Dropbox\Sign\Model\TeamAddMemberRequest $team_add_member_request (required) - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation + * @param Model\TeamAddMemberRequest $team_add_member_request (required) + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamAddMember. This method will eventually become unavailable */ - public function teamAddMemberAsync($team_add_member_request, $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) + public function teamAddMemberAsync(Model\TeamAddMemberRequest $team_add_member_request, string $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) { return $this->teamAddMemberAsyncWithHttpInfo($team_add_member_request, $team_id, $contentType) ->then( @@ -354,15 +339,15 @@ function ($response) { * * Add User to Team * - * @param \Dropbox\Sign\Model\TeamAddMemberRequest $team_add_member_request (required) - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation + * @param Model\TeamAddMemberRequest $team_add_member_request (required) + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamAddMember. This method will eventually become unavailable */ - public function teamAddMemberAsyncWithHttpInfo($team_add_member_request, $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) + public function teamAddMemberAsyncWithHttpInfo(Model\TeamAddMemberRequest $team_add_member_request, string $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) { $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; $request = $this->teamAddMemberRequest($team_add_member_request, $team_id, $contentType); @@ -372,9 +357,9 @@ public function teamAddMemberAsyncWithHttpInfo($team_add_member_request, $team_i ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -383,7 +368,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -397,7 +382,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -406,26 +391,23 @@ function ($exception) { /** * Create request for operation 'teamAddMember' * - * @param \Dropbox\Sign\Model\TeamAddMemberRequest $team_add_member_request (required) - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation + * @param Model\TeamAddMemberRequest $team_add_member_request (required) + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamAddMember. This method will eventually become unavailable */ - public function teamAddMemberRequest($team_add_member_request, $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) + public function teamAddMemberRequest(Model\TeamAddMemberRequest $team_add_member_request, string $team_id = null, string $contentType = self::contentTypes['teamAddMember'][0]) { - // verify the required parameter 'team_add_member_request' is set if ($team_add_member_request === null || (is_array($team_add_member_request) && count($team_add_member_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $team_add_member_request when calling teamAddMember' ); } - - $resourcePath = '/team/add_member'; $formParams = []; $queryParams = []; @@ -448,11 +430,8 @@ public function teamAddMemberRequest($team_add_member_request, $team_id = null, false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -460,7 +439,7 @@ public function teamAddMemberRequest($team_add_member_request, $team_id = null, // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($team_add_member_request)); } else { $httpBody = $team_add_member_request; @@ -473,7 +452,7 @@ public function teamAddMemberRequest($team_add_member_request, $team_id = null, foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -490,9 +469,8 @@ public function teamAddMemberRequest($team_add_member_request, $team_id = null, $payloadHook('multipart', $multipartContents, $team_add_member_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -535,13 +513,13 @@ public function teamAddMemberRequest($team_add_member_request, $team_id = null, * * Create Team * - * @param \Dropbox\Sign\Model\TeamCreateRequest $team_create_request team_create_request (required) + * @param Model\TeamCreateRequest $team_create_request team_create_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TeamGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function teamCreate($team_create_request) + public function teamCreate(Model\TeamCreateRequest $team_create_request) { list($response) = $this->teamCreateWithHttpInfo($team_create_request); return $response; @@ -552,15 +530,15 @@ public function teamCreate($team_create_request) * * Create Team * - * @param \Dropbox\Sign\Model\TeamCreateRequest $team_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation + * @param Model\TeamCreateRequest $team_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamCreate. This method will eventually become unavailable */ - public function teamCreateWithHttpInfo($team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) + public function teamCreateWithHttpInfo(Model\TeamCreateRequest $team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) { $request = $this->teamCreateRequest($team_create_request, $contentType); @@ -572,14 +550,14 @@ public function teamCreateWithHttpInfo($team_create_request, string $contentType } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -592,14 +570,14 @@ public function teamCreateWithHttpInfo($team_create_request, string $contentType sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -608,18 +586,17 @@ public function teamCreateWithHttpInfo($team_create_request, string $contentType if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TeamGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -636,20 +613,19 @@ public function teamCreateWithHttpInfo($team_create_request, string $contentType return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -666,11 +642,9 @@ public function teamCreateWithHttpInfo($team_create_request, string $contentType return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -683,7 +657,6 @@ public function teamCreateWithHttpInfo($team_create_request, string $contentType ); $e->setResponseObject($data); break; - } throw $e; } @@ -694,14 +667,14 @@ public function teamCreateWithHttpInfo($team_create_request, string $contentType * * Create Team * - * @param \Dropbox\Sign\Model\TeamCreateRequest $team_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation + * @param Model\TeamCreateRequest $team_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamCreate. This method will eventually become unavailable */ - public function teamCreateAsync($team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) + public function teamCreateAsync(Model\TeamCreateRequest $team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) { return $this->teamCreateAsyncWithHttpInfo($team_create_request, $contentType) ->then( @@ -716,14 +689,14 @@ function ($response) { * * Create Team * - * @param \Dropbox\Sign\Model\TeamCreateRequest $team_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation + * @param Model\TeamCreateRequest $team_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamCreate. This method will eventually become unavailable */ - public function teamCreateAsyncWithHttpInfo($team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) + public function teamCreateAsyncWithHttpInfo(Model\TeamCreateRequest $team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) { $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; $request = $this->teamCreateRequest($team_create_request, $contentType); @@ -733,9 +706,9 @@ public function teamCreateAsyncWithHttpInfo($team_create_request, string $conten ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -744,7 +717,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -758,7 +731,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -767,24 +740,22 @@ function ($exception) { /** * Create request for operation 'teamCreate' * - * @param \Dropbox\Sign\Model\TeamCreateRequest $team_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation + * @param Model\TeamCreateRequest $team_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamCreate. This method will eventually become unavailable */ - public function teamCreateRequest($team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) + public function teamCreateRequest(Model\TeamCreateRequest $team_create_request, string $contentType = self::contentTypes['teamCreate'][0]) { - // verify the required parameter 'team_create_request' is set if ($team_create_request === null || (is_array($team_create_request) && count($team_create_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $team_create_request when calling teamCreate' ); } - $resourcePath = '/team/create'; $formParams = []; $queryParams = []; @@ -798,11 +769,8 @@ public function teamCreateRequest($team_create_request, string $contentType = se $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -810,7 +778,7 @@ public function teamCreateRequest($team_create_request, string $contentType = se // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($team_create_request)); } else { $httpBody = $team_create_request; @@ -823,7 +791,7 @@ public function teamCreateRequest($team_create_request, string $contentType = se foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -840,9 +808,8 @@ public function teamCreateRequest($team_create_request, string $contentType = se $payloadHook('multipart', $multipartContents, $team_create_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -885,10 +852,8 @@ public function teamCreateRequest($team_create_request, string $contentType = se * * Delete Team * - * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return void + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ public function teamDelete() { @@ -900,11 +865,11 @@ public function teamDelete() * * Delete Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamDelete. This method will eventually become unavailable */ public function teamDeleteWithHttpInfo(string $contentType = self::contentTypes['teamDelete'][0]) @@ -919,14 +884,14 @@ public function teamDeleteWithHttpInfo(string $contentType = self::contentTypes[ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -939,23 +904,20 @@ public function teamDeleteWithHttpInfo(string $contentType = self::contentTypes[ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { - } throw $e; } @@ -966,10 +928,10 @@ public function teamDeleteWithHttpInfo(string $contentType = self::contentTypes[ * * Delete Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamDelete. This method will eventually become unavailable */ public function teamDeleteAsync(string $contentType = self::contentTypes['teamDelete'][0]) @@ -987,10 +949,10 @@ function ($response) { * * Delete Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamDelete. This method will eventually become unavailable */ public function teamDeleteAsyncWithHttpInfo(string $contentType = self::contentTypes['teamDelete'][0]) @@ -1001,7 +963,7 @@ public function teamDeleteAsyncWithHttpInfo(string $contentType = self::contentT return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) use ($returnType) { + function ($response) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -1015,7 +977,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1024,16 +986,14 @@ function ($exception) { /** * Create request for operation 'teamDelete' * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamDelete. This method will eventually become unavailable */ public function teamDeleteRequest(string $contentType = self::contentTypes['teamDelete'][0]) { - - $resourcePath = '/team/destroy'; $formParams = []; $queryParams = []; @@ -1041,12 +1001,8 @@ public function teamDeleteRequest(string $contentType = self::contentTypes['team $httpBody = ''; $multipart = false; - - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1060,7 +1016,7 @@ public function teamDeleteRequest(string $contentType = self::contentTypes['team foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1074,9 +1030,8 @@ public function teamDeleteRequest(string $contentType = self::contentTypes['team } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1119,10 +1074,9 @@ public function teamDeleteRequest(string $contentType = self::contentTypes['team * * Get Team * - * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TeamGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ public function teamGet() { @@ -1135,11 +1089,11 @@ public function teamGet() * * Get Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamGet. This method will eventually become unavailable */ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['teamGet'][0]) @@ -1154,14 +1108,14 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1174,14 +1128,14 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1190,18 +1144,17 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TeamGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1218,20 +1171,19 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1248,11 +1200,9 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1265,7 +1215,6 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te ); $e->setResponseObject($data); break; - } throw $e; } @@ -1276,10 +1225,10 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te * * Get Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamGet. This method will eventually become unavailable */ public function teamGetAsync(string $contentType = self::contentTypes['teamGet'][0]) @@ -1297,10 +1246,10 @@ function ($response) { * * Get Team * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamGet. This method will eventually become unavailable */ public function teamGetAsyncWithHttpInfo(string $contentType = self::contentTypes['teamGet'][0]) @@ -1313,9 +1262,9 @@ public function teamGetAsyncWithHttpInfo(string $contentType = self::contentType ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1324,7 +1273,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1338,7 +1287,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1347,16 +1296,14 @@ function ($exception) { /** * Create request for operation 'teamGet' * - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamGet. This method will eventually become unavailable */ public function teamGetRequest(string $contentType = self::contentTypes['teamGet'][0]) { - - $resourcePath = '/team'; $formParams = []; $queryParams = []; @@ -1364,12 +1311,8 @@ public function teamGetRequest(string $contentType = self::contentTypes['teamGet $httpBody = ''; $multipart = false; - - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1383,7 +1326,7 @@ public function teamGetRequest(string $contentType = self::contentTypes['teamGet foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1397,9 +1340,8 @@ public function teamGetRequest(string $contentType = self::contentTypes['teamGet } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1442,13 +1384,13 @@ public function teamGetRequest(string $contentType = self::contentTypes['teamGet * * Get Team Info * - * @param string $team_id The id of the team. (optional) + * @param string $team_id The id of the team. (optional) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TeamGetInfoResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TeamGetInfoResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function teamInfo($team_id = null) + public function teamInfo(string $team_id = null) { list($response) = $this->teamInfoWithHttpInfo($team_id); return $response; @@ -1459,15 +1401,15 @@ public function teamInfo($team_id = null) * * Get Team Info * - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TeamGetInfoResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TeamGetInfoResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInfo. This method will eventually become unavailable */ - public function teamInfoWithHttpInfo($team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) + public function teamInfoWithHttpInfo(string $team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) { $request = $this->teamInfoRequest($team_id, $contentType); @@ -1479,14 +1421,14 @@ public function teamInfoWithHttpInfo($team_id = null, string $contentType = self } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1499,14 +1441,14 @@ public function teamInfoWithHttpInfo($team_id = null, string $contentType = self sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1515,18 +1457,17 @@ public function teamInfoWithHttpInfo($team_id = null, string $contentType = self if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamGetInfoResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TeamGetInfoResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1543,20 +1484,19 @@ public function teamInfoWithHttpInfo($team_id = null, string $contentType = self return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetInfoResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TeamGetInfoResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1573,11 +1513,9 @@ public function teamInfoWithHttpInfo($team_id = null, string $contentType = self return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1590,7 +1528,6 @@ public function teamInfoWithHttpInfo($team_id = null, string $contentType = self ); $e->setResponseObject($data); break; - } throw $e; } @@ -1601,14 +1538,14 @@ public function teamInfoWithHttpInfo($team_id = null, string $contentType = self * * Get Team Info * - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInfo. This method will eventually become unavailable */ - public function teamInfoAsync($team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) + public function teamInfoAsync(string $team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) { return $this->teamInfoAsyncWithHttpInfo($team_id, $contentType) ->then( @@ -1623,14 +1560,14 @@ function ($response) { * * Get Team Info * - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInfo. This method will eventually become unavailable */ - public function teamInfoAsyncWithHttpInfo($team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) + public function teamInfoAsyncWithHttpInfo(string $team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) { $returnType = '\Dropbox\Sign\Model\TeamGetInfoResponse'; $request = $this->teamInfoRequest($team_id, $contentType); @@ -1640,9 +1577,9 @@ public function teamInfoAsyncWithHttpInfo($team_id = null, string $contentType = ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1651,7 +1588,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1665,7 +1602,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1674,18 +1611,15 @@ function ($exception) { /** * Create request for operation 'teamInfo' * - * @param string $team_id The id of the team. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation + * @param string $team_id The id of the team. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInfo. This method will eventually become unavailable */ - public function teamInfoRequest($team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) + public function teamInfoRequest(string $team_id = null, string $contentType = self::contentTypes['teamInfo'][0]) { - - - $resourcePath = '/team/info'; $formParams = []; $queryParams = []; @@ -1703,11 +1637,8 @@ public function teamInfoRequest($team_id = null, string $contentType = self::con false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1721,7 +1652,7 @@ public function teamInfoRequest($team_id = null, string $contentType = self::con foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1735,9 +1666,8 @@ public function teamInfoRequest($team_id = null, string $contentType = self::con } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1780,13 +1710,13 @@ public function teamInfoRequest($team_id = null, string $contentType = self::con * * List Team Invites * - * @param string $email_address The email address for which to display the team invites. (optional) + * @param string $email_address The email address for which to display the team invites. (optional) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TeamInvitesResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TeamInvitesResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function teamInvites($email_address = null) + public function teamInvites(string $email_address = null) { list($response) = $this->teamInvitesWithHttpInfo($email_address); return $response; @@ -1797,15 +1727,15 @@ public function teamInvites($email_address = null) * * List Team Invites * - * @param string $email_address The email address for which to display the team invites. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation + * @param string $email_address The email address for which to display the team invites. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TeamInvitesResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TeamInvitesResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInvites. This method will eventually become unavailable */ - public function teamInvitesWithHttpInfo($email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) + public function teamInvitesWithHttpInfo(string $email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) { $request = $this->teamInvitesRequest($email_address, $contentType); @@ -1817,14 +1747,14 @@ public function teamInvitesWithHttpInfo($email_address = null, string $contentTy } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1837,14 +1767,14 @@ public function teamInvitesWithHttpInfo($email_address = null, string $contentTy sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1853,18 +1783,17 @@ public function teamInvitesWithHttpInfo($email_address = null, string $contentTy if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamInvitesResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TeamInvitesResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1881,20 +1810,19 @@ public function teamInvitesWithHttpInfo($email_address = null, string $contentTy return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamInvitesResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TeamInvitesResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1911,11 +1839,9 @@ public function teamInvitesWithHttpInfo($email_address = null, string $contentTy return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1928,7 +1854,6 @@ public function teamInvitesWithHttpInfo($email_address = null, string $contentTy ); $e->setResponseObject($data); break; - } throw $e; } @@ -1939,14 +1864,14 @@ public function teamInvitesWithHttpInfo($email_address = null, string $contentTy * * List Team Invites * - * @param string $email_address The email address for which to display the team invites. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation + * @param string $email_address The email address for which to display the team invites. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInvites. This method will eventually become unavailable */ - public function teamInvitesAsync($email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) + public function teamInvitesAsync(string $email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) { return $this->teamInvitesAsyncWithHttpInfo($email_address, $contentType) ->then( @@ -1961,14 +1886,14 @@ function ($response) { * * List Team Invites * - * @param string $email_address The email address for which to display the team invites. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation + * @param string $email_address The email address for which to display the team invites. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInvites. This method will eventually become unavailable */ - public function teamInvitesAsyncWithHttpInfo($email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) + public function teamInvitesAsyncWithHttpInfo(string $email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) { $returnType = '\Dropbox\Sign\Model\TeamInvitesResponse'; $request = $this->teamInvitesRequest($email_address, $contentType); @@ -1978,9 +1903,9 @@ public function teamInvitesAsyncWithHttpInfo($email_address = null, string $cont ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1989,7 +1914,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2003,7 +1928,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2012,18 +1937,15 @@ function ($exception) { /** * Create request for operation 'teamInvites' * - * @param string $email_address The email address for which to display the team invites. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation + * @param string $email_address The email address for which to display the team invites. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamInvites. This method will eventually become unavailable */ - public function teamInvitesRequest($email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) + public function teamInvitesRequest(string $email_address = null, string $contentType = self::contentTypes['teamInvites'][0]) { - - - $resourcePath = '/team/invites'; $formParams = []; $queryParams = []; @@ -2041,11 +1963,8 @@ public function teamInvitesRequest($email_address = null, string $contentType = false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -2059,7 +1978,7 @@ public function teamInvitesRequest($email_address = null, string $contentType = foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2073,9 +1992,8 @@ public function teamInvitesRequest($email_address = null, string $contentType = } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2118,15 +2036,15 @@ public function teamInvitesRequest($email_address = null, string $contentType = * * List Team Members * - * @param string $team_id The id of the team that a member list is being requested from. (required) - * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $team_id The id of the team that a member list is being requested from. (required) + * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TeamMembersResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TeamMembersResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function teamMembers($team_id, $page = 1, $page_size = 20) + public function teamMembers(string $team_id, int $page = 1, int $page_size = 20) { list($response) = $this->teamMembersWithHttpInfo($team_id, $page, $page_size); return $response; @@ -2137,17 +2055,17 @@ public function teamMembers($team_id, $page = 1, $page_size = 20) * * List Team Members * - * @param string $team_id The id of the team that a member list is being requested from. (required) - * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation + * @param string $team_id The id of the team that a member list is being requested from. (required) + * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TeamMembersResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TeamMembersResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamMembers. This method will eventually become unavailable */ - public function teamMembersWithHttpInfo($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) + public function teamMembersWithHttpInfo(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) { $request = $this->teamMembersRequest($team_id, $page, $page_size, $contentType); @@ -2159,14 +2077,14 @@ public function teamMembersWithHttpInfo($team_id, $page = 1, $page_size = 20, st } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -2179,14 +2097,14 @@ public function teamMembersWithHttpInfo($team_id, $page = 1, $page_size = 20, st sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2195,18 +2113,17 @@ public function teamMembersWithHttpInfo($team_id, $page = 1, $page_size = 20, st if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamMembersResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TeamMembersResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2223,20 +2140,19 @@ public function teamMembersWithHttpInfo($team_id, $page = 1, $page_size = 20, st return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamMembersResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TeamMembersResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2253,11 +2169,9 @@ public function teamMembersWithHttpInfo($team_id, $page = 1, $page_size = 20, st return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2270,7 +2184,6 @@ public function teamMembersWithHttpInfo($team_id, $page = 1, $page_size = 20, st ); $e->setResponseObject($data); break; - } throw $e; } @@ -2281,16 +2194,16 @@ public function teamMembersWithHttpInfo($team_id, $page = 1, $page_size = 20, st * * List Team Members * - * @param string $team_id The id of the team that a member list is being requested from. (required) - * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation + * @param string $team_id The id of the team that a member list is being requested from. (required) + * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamMembers. This method will eventually become unavailable */ - public function teamMembersAsync($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) + public function teamMembersAsync(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) { return $this->teamMembersAsyncWithHttpInfo($team_id, $page, $page_size, $contentType) ->then( @@ -2305,16 +2218,16 @@ function ($response) { * * List Team Members * - * @param string $team_id The id of the team that a member list is being requested from. (required) - * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation + * @param string $team_id The id of the team that a member list is being requested from. (required) + * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamMembers. This method will eventually become unavailable */ - public function teamMembersAsyncWithHttpInfo($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) + public function teamMembersAsyncWithHttpInfo(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) { $returnType = '\Dropbox\Sign\Model\TeamMembersResponse'; $request = $this->teamMembersRequest($team_id, $page, $page_size, $contentType); @@ -2324,9 +2237,9 @@ public function teamMembersAsyncWithHttpInfo($team_id, $page = 1, $page_size = 2 ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2335,7 +2248,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2349,7 +2262,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2358,33 +2271,30 @@ function ($exception) { /** * Create request for operation 'teamMembers' * - * @param string $team_id The id of the team that a member list is being requested from. (required) - * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation + * @param string $team_id The id of the team that a member list is being requested from. (required) + * @param int $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamMembers'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamMembers. This method will eventually become unavailable */ - public function teamMembersRequest($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) + public function teamMembersRequest(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamMembers'][0]) { - // verify the required parameter 'team_id' is set if ($team_id === null || (is_array($team_id) && count($team_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $team_id when calling teamMembers' ); } - if ($page_size !== null && $page_size > 100) { - throw new \InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamMembers, must be smaller than or equal to 100.'); + throw new InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamMembers, must be smaller than or equal to 100.'); } if ($page_size !== null && $page_size < 1) { - throw new \InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamMembers, must be bigger than or equal to 1.'); + throw new InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamMembers, must be bigger than or equal to 1.'); } - $resourcePath = '/team/members/{team_id}'; $formParams = []; @@ -2412,19 +2322,17 @@ public function teamMembersRequest($team_id, $page = 1, $page_size = 20, string false // required ) ?? []); - // path params if ($team_id !== null) { $resourcePath = str_replace( - '{' . 'team_id' . '}', + '{team_id}', ObjectSerializer::toPathValue($team_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -2438,7 +2346,7 @@ public function teamMembersRequest($team_id, $page = 1, $page_size = 20, string foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2452,9 +2360,8 @@ public function teamMembersRequest($team_id, $page = 1, $page_size = 20, string } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2497,13 +2404,13 @@ public function teamMembersRequest($team_id, $page = 1, $page_size = 20, string * * Remove User from Team * - * @param \Dropbox\Sign\Model\TeamRemoveMemberRequest $team_remove_member_request team_remove_member_request (required) + * @param Model\TeamRemoveMemberRequest $team_remove_member_request team_remove_member_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TeamGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function teamRemoveMember($team_remove_member_request) + public function teamRemoveMember(Model\TeamRemoveMemberRequest $team_remove_member_request) { list($response) = $this->teamRemoveMemberWithHttpInfo($team_remove_member_request); return $response; @@ -2514,15 +2421,15 @@ public function teamRemoveMember($team_remove_member_request) * * Remove User from Team * - * @param \Dropbox\Sign\Model\TeamRemoveMemberRequest $team_remove_member_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation + * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamRemoveMember. This method will eventually become unavailable */ - public function teamRemoveMemberWithHttpInfo($team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) + public function teamRemoveMemberWithHttpInfo(Model\TeamRemoveMemberRequest $team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) { $request = $this->teamRemoveMemberRequest($team_remove_member_request, $contentType); @@ -2534,14 +2441,14 @@ public function teamRemoveMemberWithHttpInfo($team_remove_member_request, string } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -2554,14 +2461,14 @@ public function teamRemoveMemberWithHttpInfo($team_remove_member_request, string sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2570,18 +2477,17 @@ public function teamRemoveMemberWithHttpInfo($team_remove_member_request, string if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 201: if ('\Dropbox\Sign\Model\TeamGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TeamGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2598,20 +2504,19 @@ public function teamRemoveMemberWithHttpInfo($team_remove_member_request, string return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2628,11 +2533,9 @@ public function teamRemoveMemberWithHttpInfo($team_remove_member_request, string return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2645,7 +2548,6 @@ public function teamRemoveMemberWithHttpInfo($team_remove_member_request, string ); $e->setResponseObject($data); break; - } throw $e; } @@ -2656,14 +2558,14 @@ public function teamRemoveMemberWithHttpInfo($team_remove_member_request, string * * Remove User from Team * - * @param \Dropbox\Sign\Model\TeamRemoveMemberRequest $team_remove_member_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation + * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamRemoveMember. This method will eventually become unavailable */ - public function teamRemoveMemberAsync($team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) + public function teamRemoveMemberAsync(Model\TeamRemoveMemberRequest $team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) { return $this->teamRemoveMemberAsyncWithHttpInfo($team_remove_member_request, $contentType) ->then( @@ -2678,14 +2580,14 @@ function ($response) { * * Remove User from Team * - * @param \Dropbox\Sign\Model\TeamRemoveMemberRequest $team_remove_member_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation + * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamRemoveMember. This method will eventually become unavailable */ - public function teamRemoveMemberAsyncWithHttpInfo($team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) + public function teamRemoveMemberAsyncWithHttpInfo(Model\TeamRemoveMemberRequest $team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) { $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; $request = $this->teamRemoveMemberRequest($team_remove_member_request, $contentType); @@ -2695,9 +2597,9 @@ public function teamRemoveMemberAsyncWithHttpInfo($team_remove_member_request, s ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2706,7 +2608,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2720,7 +2622,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2729,24 +2631,22 @@ function ($exception) { /** * Create request for operation 'teamRemoveMember' * - * @param \Dropbox\Sign\Model\TeamRemoveMemberRequest $team_remove_member_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation + * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamRemoveMember. This method will eventually become unavailable */ - public function teamRemoveMemberRequest($team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) + public function teamRemoveMemberRequest(Model\TeamRemoveMemberRequest $team_remove_member_request, string $contentType = self::contentTypes['teamRemoveMember'][0]) { - // verify the required parameter 'team_remove_member_request' is set if ($team_remove_member_request === null || (is_array($team_remove_member_request) && count($team_remove_member_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $team_remove_member_request when calling teamRemoveMember' ); } - $resourcePath = '/team/remove_member'; $formParams = []; $queryParams = []; @@ -2760,11 +2660,8 @@ public function teamRemoveMemberRequest($team_remove_member_request, string $con $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -2772,7 +2669,7 @@ public function teamRemoveMemberRequest($team_remove_member_request, string $con // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($team_remove_member_request)); } else { $httpBody = $team_remove_member_request; @@ -2785,7 +2682,7 @@ public function teamRemoveMemberRequest($team_remove_member_request, string $con foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2802,9 +2699,8 @@ public function teamRemoveMemberRequest($team_remove_member_request, string $con $payloadHook('multipart', $multipartContents, $team_remove_member_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2847,15 +2743,15 @@ public function teamRemoveMemberRequest($team_remove_member_request, string $con * * List Sub Teams * - * @param string $team_id The id of the parent Team. (required) - * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $team_id The id of the parent Team. (required) + * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TeamSubTeamsResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TeamSubTeamsResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function teamSubTeams($team_id, $page = 1, $page_size = 20) + public function teamSubTeams(string $team_id, int $page = 1, int $page_size = 20) { list($response) = $this->teamSubTeamsWithHttpInfo($team_id, $page, $page_size); return $response; @@ -2866,17 +2762,17 @@ public function teamSubTeams($team_id, $page = 1, $page_size = 20) * * List Sub Teams * - * @param string $team_id The id of the parent Team. (required) - * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation + * @param string $team_id The id of the parent Team. (required) + * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TeamSubTeamsResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TeamSubTeamsResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamSubTeams. This method will eventually become unavailable */ - public function teamSubTeamsWithHttpInfo($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) + public function teamSubTeamsWithHttpInfo(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) { $request = $this->teamSubTeamsRequest($team_id, $page, $page_size, $contentType); @@ -2888,14 +2784,14 @@ public function teamSubTeamsWithHttpInfo($team_id, $page = 1, $page_size = 20, s } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -2908,14 +2804,14 @@ public function teamSubTeamsWithHttpInfo($team_id, $page = 1, $page_size = 20, s sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2924,18 +2820,17 @@ public function teamSubTeamsWithHttpInfo($team_id, $page = 1, $page_size = 20, s if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamSubTeamsResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TeamSubTeamsResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2952,20 +2847,19 @@ public function teamSubTeamsWithHttpInfo($team_id, $page = 1, $page_size = 20, s return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamSubTeamsResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TeamSubTeamsResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2982,11 +2876,9 @@ public function teamSubTeamsWithHttpInfo($team_id, $page = 1, $page_size = 20, s return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2999,7 +2891,6 @@ public function teamSubTeamsWithHttpInfo($team_id, $page = 1, $page_size = 20, s ); $e->setResponseObject($data); break; - } throw $e; } @@ -3010,16 +2901,16 @@ public function teamSubTeamsWithHttpInfo($team_id, $page = 1, $page_size = 20, s * * List Sub Teams * - * @param string $team_id The id of the parent Team. (required) - * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation + * @param string $team_id The id of the parent Team. (required) + * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamSubTeams. This method will eventually become unavailable */ - public function teamSubTeamsAsync($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) + public function teamSubTeamsAsync(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) { return $this->teamSubTeamsAsyncWithHttpInfo($team_id, $page, $page_size, $contentType) ->then( @@ -3034,16 +2925,16 @@ function ($response) { * * List Sub Teams * - * @param string $team_id The id of the parent Team. (required) - * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation + * @param string $team_id The id of the parent Team. (required) + * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamSubTeams. This method will eventually become unavailable */ - public function teamSubTeamsAsyncWithHttpInfo($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) + public function teamSubTeamsAsyncWithHttpInfo(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) { $returnType = '\Dropbox\Sign\Model\TeamSubTeamsResponse'; $request = $this->teamSubTeamsRequest($team_id, $page, $page_size, $contentType); @@ -3053,9 +2944,9 @@ public function teamSubTeamsAsyncWithHttpInfo($team_id, $page = 1, $page_size = ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3064,7 +2955,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -3078,7 +2969,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -3087,33 +2978,30 @@ function ($exception) { /** * Create request for operation 'teamSubTeams' * - * @param string $team_id The id of the parent Team. (required) - * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation + * @param string $team_id The id of the parent Team. (required) + * @param int $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamSubTeams'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamSubTeams. This method will eventually become unavailable */ - public function teamSubTeamsRequest($team_id, $page = 1, $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) + public function teamSubTeamsRequest(string $team_id, int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['teamSubTeams'][0]) { - // verify the required parameter 'team_id' is set if ($team_id === null || (is_array($team_id) && count($team_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $team_id when calling teamSubTeams' ); } - if ($page_size !== null && $page_size > 100) { - throw new \InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamSubTeams, must be smaller than or equal to 100.'); + throw new InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamSubTeams, must be smaller than or equal to 100.'); } if ($page_size !== null && $page_size < 1) { - throw new \InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamSubTeams, must be bigger than or equal to 1.'); + throw new InvalidArgumentException('invalid value for "$page_size" when calling TeamApi.teamSubTeams, must be bigger than or equal to 1.'); } - $resourcePath = '/team/sub_teams/{team_id}'; $formParams = []; @@ -3141,19 +3029,17 @@ public function teamSubTeamsRequest($team_id, $page = 1, $page_size = 20, string false // required ) ?? []); - // path params if ($team_id !== null) { $resourcePath = str_replace( - '{' . 'team_id' . '}', + '{team_id}', ObjectSerializer::toPathValue($team_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -3167,7 +3053,7 @@ public function teamSubTeamsRequest($team_id, $page = 1, $page_size = 20, string foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -3181,9 +3067,8 @@ public function teamSubTeamsRequest($team_id, $page = 1, $page_size = 20, string } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3226,13 +3111,13 @@ public function teamSubTeamsRequest($team_id, $page = 1, $page_size = 20, string * * Update Team * - * @param \Dropbox\Sign\Model\TeamUpdateRequest $team_update_request team_update_request (required) + * @param Model\TeamUpdateRequest $team_update_request team_update_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TeamGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function teamUpdate($team_update_request) + public function teamUpdate(Model\TeamUpdateRequest $team_update_request) { list($response) = $this->teamUpdateWithHttpInfo($team_update_request); return $response; @@ -3243,15 +3128,15 @@ public function teamUpdate($team_update_request) * * Update Team * - * @param \Dropbox\Sign\Model\TeamUpdateRequest $team_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation + * @param Model\TeamUpdateRequest $team_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TeamGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamUpdate. This method will eventually become unavailable */ - public function teamUpdateWithHttpInfo($team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) + public function teamUpdateWithHttpInfo(Model\TeamUpdateRequest $team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) { $request = $this->teamUpdateRequest($team_update_request, $contentType); @@ -3263,14 +3148,14 @@ public function teamUpdateWithHttpInfo($team_update_request, string $contentType } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -3283,14 +3168,14 @@ public function teamUpdateWithHttpInfo($team_update_request, string $contentType sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3299,18 +3184,17 @@ public function teamUpdateWithHttpInfo($team_update_request, string $contentType if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TeamGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TeamGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3327,20 +3211,19 @@ public function teamUpdateWithHttpInfo($team_update_request, string $contentType return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TeamGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3357,11 +3240,9 @@ public function teamUpdateWithHttpInfo($team_update_request, string $contentType return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3374,7 +3255,6 @@ public function teamUpdateWithHttpInfo($team_update_request, string $contentType ); $e->setResponseObject($data); break; - } throw $e; } @@ -3385,14 +3265,14 @@ public function teamUpdateWithHttpInfo($team_update_request, string $contentType * * Update Team * - * @param \Dropbox\Sign\Model\TeamUpdateRequest $team_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation + * @param Model\TeamUpdateRequest $team_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamUpdate. This method will eventually become unavailable */ - public function teamUpdateAsync($team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) + public function teamUpdateAsync(Model\TeamUpdateRequest $team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) { return $this->teamUpdateAsyncWithHttpInfo($team_update_request, $contentType) ->then( @@ -3407,14 +3287,14 @@ function ($response) { * * Update Team * - * @param \Dropbox\Sign\Model\TeamUpdateRequest $team_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation + * @param Model\TeamUpdateRequest $team_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamUpdate. This method will eventually become unavailable */ - public function teamUpdateAsyncWithHttpInfo($team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) + public function teamUpdateAsyncWithHttpInfo(Model\TeamUpdateRequest $team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) { $returnType = '\Dropbox\Sign\Model\TeamGetResponse'; $request = $this->teamUpdateRequest($team_update_request, $contentType); @@ -3424,9 +3304,9 @@ public function teamUpdateAsyncWithHttpInfo($team_update_request, string $conten ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3435,7 +3315,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -3449,7 +3329,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -3458,24 +3338,22 @@ function ($exception) { /** * Create request for operation 'teamUpdate' * - * @param \Dropbox\Sign\Model\TeamUpdateRequest $team_update_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation + * @param Model\TeamUpdateRequest $team_update_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::teamUpdate. This method will eventually become unavailable */ - public function teamUpdateRequest($team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) + public function teamUpdateRequest(Model\TeamUpdateRequest $team_update_request, string $contentType = self::contentTypes['teamUpdate'][0]) { - // verify the required parameter 'team_update_request' is set if ($team_update_request === null || (is_array($team_update_request) && count($team_update_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $team_update_request when calling teamUpdate' ); } - $resourcePath = '/team'; $formParams = []; $queryParams = []; @@ -3489,11 +3367,8 @@ public function teamUpdateRequest($team_update_request, string $contentType = se $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -3501,7 +3376,7 @@ public function teamUpdateRequest($team_update_request, string $contentType = se // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($team_update_request)); } else { $httpBody = $team_update_request; @@ -3514,7 +3389,7 @@ public function teamUpdateRequest($team_update_request, string $contentType = se foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -3531,9 +3406,8 @@ public function teamUpdateRequest($team_update_request, string $contentType = se $payloadHook('multipart', $multipartContents, $team_update_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3574,8 +3448,8 @@ public function teamUpdateRequest($team_update_request, string $contentType = se /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -3583,7 +3457,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -3599,8 +3473,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -3610,9 +3484,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -3631,8 +3505,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/TemplateApi.php b/sdks/php/src/Api/TemplateApi.php index 5926911eb..091dc84d6 100644 --- a/sdks/php/src/Api/TemplateApi.php +++ b/sdks/php/src/Api/TemplateApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,35 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; +use SplFileObject; /** * TemplateApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class TemplateApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'templateAddUser' => [ 'application/json', @@ -116,16 +110,13 @@ class TemplateApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -139,7 +130,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -176,14 +167,14 @@ public function getResponse() * * Add User to Template * - * @param string $template_id The id of the Template to give the Account access to. (required) - * @param \Dropbox\Sign\Model\TemplateAddUserRequest $template_add_user_request template_add_user_request (required) + * @param string $template_id The id of the Template to give the Account access to. (required) + * @param Model\TemplateAddUserRequest $template_add_user_request template_add_user_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TemplateGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateAddUser($template_id, $template_add_user_request) + public function templateAddUser(string $template_id, Model\TemplateAddUserRequest $template_add_user_request) { list($response) = $this->templateAddUserWithHttpInfo($template_id, $template_add_user_request); return $response; @@ -194,16 +185,16 @@ public function templateAddUser($template_id, $template_add_user_request) * * Add User to Template * - * @param string $template_id The id of the Template to give the Account access to. (required) - * @param \Dropbox\Sign\Model\TemplateAddUserRequest $template_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to give the Account access to. (required) + * @param Model\TemplateAddUserRequest $template_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TemplateGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateAddUser. This method will eventually become unavailable */ - public function templateAddUserWithHttpInfo($template_id, $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) + public function templateAddUserWithHttpInfo(string $template_id, Model\TemplateAddUserRequest $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) { $request = $this->templateAddUserRequest($template_id, $template_add_user_request, $contentType); @@ -215,14 +206,14 @@ public function templateAddUserWithHttpInfo($template_id, $template_add_user_req } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -235,14 +226,14 @@ public function templateAddUserWithHttpInfo($template_id, $template_add_user_req sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -251,18 +242,17 @@ public function templateAddUserWithHttpInfo($template_id, $template_add_user_req if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TemplateGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -279,20 +269,19 @@ public function templateAddUserWithHttpInfo($template_id, $template_add_user_req return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -309,11 +298,9 @@ public function templateAddUserWithHttpInfo($template_id, $template_add_user_req return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -326,7 +313,6 @@ public function templateAddUserWithHttpInfo($template_id, $template_add_user_req ); $e->setResponseObject($data); break; - } throw $e; } @@ -337,15 +323,15 @@ public function templateAddUserWithHttpInfo($template_id, $template_add_user_req * * Add User to Template * - * @param string $template_id The id of the Template to give the Account access to. (required) - * @param \Dropbox\Sign\Model\TemplateAddUserRequest $template_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to give the Account access to. (required) + * @param Model\TemplateAddUserRequest $template_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateAddUser. This method will eventually become unavailable */ - public function templateAddUserAsync($template_id, $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) + public function templateAddUserAsync(string $template_id, Model\TemplateAddUserRequest $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) { return $this->templateAddUserAsyncWithHttpInfo($template_id, $template_add_user_request, $contentType) ->then( @@ -360,15 +346,15 @@ function ($response) { * * Add User to Template * - * @param string $template_id The id of the Template to give the Account access to. (required) - * @param \Dropbox\Sign\Model\TemplateAddUserRequest $template_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to give the Account access to. (required) + * @param Model\TemplateAddUserRequest $template_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateAddUser. This method will eventually become unavailable */ - public function templateAddUserAsyncWithHttpInfo($template_id, $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) + public function templateAddUserAsyncWithHttpInfo(string $template_id, Model\TemplateAddUserRequest $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; $request = $this->templateAddUserRequest($template_id, $template_add_user_request, $contentType); @@ -378,9 +364,9 @@ public function templateAddUserAsyncWithHttpInfo($template_id, $template_add_use ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -389,7 +375,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -403,7 +389,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -412,32 +398,30 @@ function ($exception) { /** * Create request for operation 'templateAddUser' * - * @param string $template_id The id of the Template to give the Account access to. (required) - * @param \Dropbox\Sign\Model\TemplateAddUserRequest $template_add_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to give the Account access to. (required) + * @param Model\TemplateAddUserRequest $template_add_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateAddUser. This method will eventually become unavailable */ - public function templateAddUserRequest($template_id, $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) + public function templateAddUserRequest(string $template_id, Model\TemplateAddUserRequest $template_add_user_request, string $contentType = self::contentTypes['templateAddUser'][0]) { - // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_id when calling templateAddUser' ); } // verify the required parameter 'template_add_user_request' is set if ($template_add_user_request === null || (is_array($template_add_user_request) && count($template_add_user_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_add_user_request when calling templateAddUser' ); } - $resourcePath = '/template/add_user/{template_id}'; $formParams = []; $queryParams = []; @@ -451,19 +435,17 @@ public function templateAddUserRequest($template_id, $template_add_user_request, $multipart = !empty($formParams); - // path params if ($template_id !== null) { $resourcePath = str_replace( - '{' . 'template_id' . '}', + '{template_id}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -471,7 +453,7 @@ public function templateAddUserRequest($template_id, $template_add_user_request, // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_add_user_request)); } else { $httpBody = $template_add_user_request; @@ -484,7 +466,7 @@ public function templateAddUserRequest($template_id, $template_add_user_request, foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -501,9 +483,8 @@ public function templateAddUserRequest($template_id, $template_add_user_request, $payloadHook('multipart', $multipartContents, $template_add_user_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -546,13 +527,13 @@ public function templateAddUserRequest($template_id, $template_add_user_request, * * Create Template * - * @param \Dropbox\Sign\Model\TemplateCreateRequest $template_create_request template_create_request (required) + * @param Model\TemplateCreateRequest $template_create_request template_create_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TemplateCreateResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TemplateCreateResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateCreate($template_create_request) + public function templateCreate(Model\TemplateCreateRequest $template_create_request) { list($response) = $this->templateCreateWithHttpInfo($template_create_request); return $response; @@ -563,15 +544,15 @@ public function templateCreate($template_create_request) * * Create Template * - * @param \Dropbox\Sign\Model\TemplateCreateRequest $template_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation + * @param Model\TemplateCreateRequest $template_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TemplateCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TemplateCreateResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreate. This method will eventually become unavailable */ - public function templateCreateWithHttpInfo($template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) + public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) { $request = $this->templateCreateRequest($template_create_request, $contentType); @@ -583,14 +564,14 @@ public function templateCreateWithHttpInfo($template_create_request, string $con } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -603,14 +584,14 @@ public function templateCreateWithHttpInfo($template_create_request, string $con sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -619,18 +600,17 @@ public function templateCreateWithHttpInfo($template_create_request, string $con if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TemplateCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -647,20 +627,19 @@ public function templateCreateWithHttpInfo($template_create_request, string $con return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateCreateResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TemplateCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -677,11 +656,9 @@ public function templateCreateWithHttpInfo($template_create_request, string $con return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -694,7 +671,6 @@ public function templateCreateWithHttpInfo($template_create_request, string $con ); $e->setResponseObject($data); break; - } throw $e; } @@ -705,14 +681,14 @@ public function templateCreateWithHttpInfo($template_create_request, string $con * * Create Template * - * @param \Dropbox\Sign\Model\TemplateCreateRequest $template_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation + * @param Model\TemplateCreateRequest $template_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreate. This method will eventually become unavailable */ - public function templateCreateAsync($template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) + public function templateCreateAsync(Model\TemplateCreateRequest $template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) { return $this->templateCreateAsyncWithHttpInfo($template_create_request, $contentType) ->then( @@ -727,14 +703,14 @@ function ($response) { * * Create Template * - * @param \Dropbox\Sign\Model\TemplateCreateRequest $template_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation + * @param Model\TemplateCreateRequest $template_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreate. This method will eventually become unavailable */ - public function templateCreateAsyncWithHttpInfo($template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) + public function templateCreateAsyncWithHttpInfo(Model\TemplateCreateRequest $template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateCreateResponse'; $request = $this->templateCreateRequest($template_create_request, $contentType); @@ -744,9 +720,9 @@ public function templateCreateAsyncWithHttpInfo($template_create_request, string ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -755,7 +731,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -769,7 +745,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -778,24 +754,22 @@ function ($exception) { /** * Create request for operation 'templateCreate' * - * @param \Dropbox\Sign\Model\TemplateCreateRequest $template_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation + * @param Model\TemplateCreateRequest $template_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreate. This method will eventually become unavailable */ - public function templateCreateRequest($template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) + public function templateCreateRequest(Model\TemplateCreateRequest $template_create_request, string $contentType = self::contentTypes['templateCreate'][0]) { - // verify the required parameter 'template_create_request' is set if ($template_create_request === null || (is_array($template_create_request) && count($template_create_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_create_request when calling templateCreate' ); } - $resourcePath = '/template/create'; $formParams = []; $queryParams = []; @@ -809,11 +783,8 @@ public function templateCreateRequest($template_create_request, string $contentT $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -821,7 +792,7 @@ public function templateCreateRequest($template_create_request, string $contentT // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_create_request)); } else { $httpBody = $template_create_request; @@ -834,7 +805,7 @@ public function templateCreateRequest($template_create_request, string $contentT foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -851,9 +822,8 @@ public function templateCreateRequest($template_create_request, string $contentT $payloadHook('multipart', $multipartContents, $template_create_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -896,13 +866,13 @@ public function templateCreateRequest($template_create_request, string $contentT * * Create Embedded Template Draft * - * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request template_create_embedded_draft_request (required) + * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request template_create_embedded_draft_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TemplateCreateEmbeddedDraftResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateCreateEmbeddedDraft($template_create_embedded_draft_request) + public function templateCreateEmbeddedDraft(Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request) { list($response) = $this->templateCreateEmbeddedDraftWithHttpInfo($template_create_embedded_draft_request); return $response; @@ -913,15 +883,15 @@ public function templateCreateEmbeddedDraft($template_create_embedded_draft_requ * * Create Embedded Template Draft * - * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation + * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TemplateCreateEmbeddedDraftResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreateEmbeddedDraft. This method will eventually become unavailable */ - public function templateCreateEmbeddedDraftWithHttpInfo($template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) + public function templateCreateEmbeddedDraftWithHttpInfo(Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) { $request = $this->templateCreateEmbeddedDraftRequest($template_create_embedded_draft_request, $contentType); @@ -933,14 +903,14 @@ public function templateCreateEmbeddedDraftWithHttpInfo($template_create_embedde } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -953,14 +923,14 @@ public function templateCreateEmbeddedDraftWithHttpInfo($template_create_embedde sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -969,18 +939,17 @@ public function templateCreateEmbeddedDraftWithHttpInfo($template_create_embedde if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -997,20 +966,19 @@ public function templateCreateEmbeddedDraftWithHttpInfo($template_create_embedde return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1027,11 +995,9 @@ public function templateCreateEmbeddedDraftWithHttpInfo($template_create_embedde return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1044,7 +1010,6 @@ public function templateCreateEmbeddedDraftWithHttpInfo($template_create_embedde ); $e->setResponseObject($data); break; - } throw $e; } @@ -1055,14 +1020,14 @@ public function templateCreateEmbeddedDraftWithHttpInfo($template_create_embedde * * Create Embedded Template Draft * - * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation + * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreateEmbeddedDraft. This method will eventually become unavailable */ - public function templateCreateEmbeddedDraftAsync($template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) + public function templateCreateEmbeddedDraftAsync(Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) { return $this->templateCreateEmbeddedDraftAsyncWithHttpInfo($template_create_embedded_draft_request, $contentType) ->then( @@ -1077,14 +1042,14 @@ function ($response) { * * Create Embedded Template Draft * - * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation + * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreateEmbeddedDraft. This method will eventually become unavailable */ - public function templateCreateEmbeddedDraftAsyncWithHttpInfo($template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) + public function templateCreateEmbeddedDraftAsyncWithHttpInfo(Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse'; $request = $this->templateCreateEmbeddedDraftRequest($template_create_embedded_draft_request, $contentType); @@ -1094,9 +1059,9 @@ public function templateCreateEmbeddedDraftAsyncWithHttpInfo($template_create_em ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1105,7 +1070,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1119,7 +1084,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1128,24 +1093,22 @@ function ($exception) { /** * Create request for operation 'templateCreateEmbeddedDraft' * - * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation + * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateCreateEmbeddedDraft. This method will eventually become unavailable */ - public function templateCreateEmbeddedDraftRequest($template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) + public function templateCreateEmbeddedDraftRequest(Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request, string $contentType = self::contentTypes['templateCreateEmbeddedDraft'][0]) { - // verify the required parameter 'template_create_embedded_draft_request' is set if ($template_create_embedded_draft_request === null || (is_array($template_create_embedded_draft_request) && count($template_create_embedded_draft_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_create_embedded_draft_request when calling templateCreateEmbeddedDraft' ); } - $resourcePath = '/template/create_embedded_draft'; $formParams = []; $queryParams = []; @@ -1159,11 +1122,8 @@ public function templateCreateEmbeddedDraftRequest($template_create_embedded_dra $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1171,7 +1131,7 @@ public function templateCreateEmbeddedDraftRequest($template_create_embedded_dra // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_create_embedded_draft_request)); } else { $httpBody = $template_create_embedded_draft_request; @@ -1184,7 +1144,7 @@ public function templateCreateEmbeddedDraftRequest($template_create_embedded_dra foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1201,9 +1161,8 @@ public function templateCreateEmbeddedDraftRequest($template_create_embedded_dra $payloadHook('multipart', $multipartContents, $template_create_embedded_draft_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1246,13 +1205,12 @@ public function templateCreateEmbeddedDraftRequest($template_create_embedded_dra * * Delete Template * - * @param string $template_id The id of the Template to delete. (required) + * @param string $template_id The id of the Template to delete. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return void + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateDelete($template_id) + public function templateDelete(string $template_id) { $this->templateDeleteWithHttpInfo($template_id); } @@ -1262,15 +1220,15 @@ public function templateDelete($template_id) * * Delete Template * - * @param string $template_id The id of the Template to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation + * @param string $template_id The id of the Template to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateDelete. This method will eventually become unavailable */ - public function templateDeleteWithHttpInfo($template_id, string $contentType = self::contentTypes['templateDelete'][0]) + public function templateDeleteWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateDelete'][0]) { $request = $this->templateDeleteRequest($template_id, $contentType); @@ -1282,14 +1240,14 @@ public function templateDeleteWithHttpInfo($template_id, string $contentType = s } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1302,23 +1260,20 @@ public function templateDeleteWithHttpInfo($template_id, string $contentType = s sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } switch ($e->getCode()) { - } throw $e; } @@ -1329,14 +1284,14 @@ public function templateDeleteWithHttpInfo($template_id, string $contentType = s * * Delete Template * - * @param string $template_id The id of the Template to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation + * @param string $template_id The id of the Template to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateDelete. This method will eventually become unavailable */ - public function templateDeleteAsync($template_id, string $contentType = self::contentTypes['templateDelete'][0]) + public function templateDeleteAsync(string $template_id, string $contentType = self::contentTypes['templateDelete'][0]) { return $this->templateDeleteAsyncWithHttpInfo($template_id, $contentType) ->then( @@ -1351,14 +1306,14 @@ function ($response) { * * Delete Template * - * @param string $template_id The id of the Template to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation + * @param string $template_id The id of the Template to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateDelete. This method will eventually become unavailable */ - public function templateDeleteAsyncWithHttpInfo($template_id, string $contentType = self::contentTypes['templateDelete'][0]) + public function templateDeleteAsyncWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateDelete'][0]) { $returnType = ''; $request = $this->templateDeleteRequest($template_id, $contentType); @@ -1366,7 +1321,7 @@ public function templateDeleteAsyncWithHttpInfo($template_id, string $contentTyp return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( - function ($response) use ($returnType) { + function ($response) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { @@ -1380,7 +1335,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1389,24 +1344,22 @@ function ($exception) { /** * Create request for operation 'templateDelete' * - * @param string $template_id The id of the Template to delete. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation + * @param string $template_id The id of the Template to delete. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateDelete. This method will eventually become unavailable */ - public function templateDeleteRequest($template_id, string $contentType = self::contentTypes['templateDelete'][0]) + public function templateDeleteRequest(string $template_id, string $contentType = self::contentTypes['templateDelete'][0]) { - // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_id when calling templateDelete' ); } - $resourcePath = '/template/delete/{template_id}'; $formParams = []; $queryParams = []; @@ -1414,20 +1367,17 @@ public function templateDeleteRequest($template_id, string $contentType = self:: $httpBody = ''; $multipart = false; - - // path params if ($template_id !== null) { $resourcePath = str_replace( - '{' . 'template_id' . '}', + '{template_id}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1441,7 +1391,7 @@ public function templateDeleteRequest($template_id, string $contentType = self:: foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1455,9 +1405,8 @@ public function templateDeleteRequest($template_id, string $contentType = self:: } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1500,14 +1449,14 @@ public function templateDeleteRequest($template_id, string $contentType = self:: * * Get Template Files * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \SplFileObject|\Dropbox\Sign\Model\ErrorResponse + * @return SplFileObject + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateFiles($template_id, $file_type = null) + public function templateFiles(string $template_id, string $file_type = null) { list($response) = $this->templateFilesWithHttpInfo($template_id, $file_type); return $response; @@ -1518,16 +1467,16 @@ public function templateFiles($template_id, $file_type = null) * * Get Template Files * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException * @return array of \SplFileObject|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFiles. This method will eventually become unavailable */ - public function templateFilesWithHttpInfo($template_id, $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) + public function templateFilesWithHttpInfo(string $template_id, string $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) { $request = $this->templateFilesRequest($template_id, $file_type, $contentType); @@ -1539,14 +1488,14 @@ public function templateFilesWithHttpInfo($template_id, $file_type = null, strin } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1559,14 +1508,14 @@ public function templateFilesWithHttpInfo($template_id, $file_type = null, strin sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1575,18 +1524,17 @@ public function templateFilesWithHttpInfo($template_id, $file_type = null, strin if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\SplFileObject' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\SplFileObject' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1603,20 +1551,19 @@ public function templateFilesWithHttpInfo($template_id, $file_type = null, strin return [ ObjectSerializer::deserialize($content, '\SplFileObject', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\SplFileObject'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1633,11 +1580,9 @@ public function templateFilesWithHttpInfo($template_id, $file_type = null, strin return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1650,7 +1595,6 @@ public function templateFilesWithHttpInfo($template_id, $file_type = null, strin ); $e->setResponseObject($data); break; - } throw $e; } @@ -1661,15 +1605,15 @@ public function templateFilesWithHttpInfo($template_id, $file_type = null, strin * * Get Template Files * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFiles. This method will eventually become unavailable */ - public function templateFilesAsync($template_id, $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) + public function templateFilesAsync(string $template_id, string $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) { return $this->templateFilesAsyncWithHttpInfo($template_id, $file_type, $contentType) ->then( @@ -1684,15 +1628,15 @@ function ($response) { * * Get Template Files * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFiles. This method will eventually become unavailable */ - public function templateFilesAsyncWithHttpInfo($template_id, $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) + public function templateFilesAsyncWithHttpInfo(string $template_id, string $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) { $returnType = '\SplFileObject'; $request = $this->templateFilesRequest($template_id, $file_type, $contentType); @@ -1702,9 +1646,9 @@ public function templateFilesAsyncWithHttpInfo($template_id, $file_type = null, ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1713,7 +1657,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1727,7 +1671,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1736,26 +1680,23 @@ function ($exception) { /** * Create request for operation 'templateFiles' * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFiles. This method will eventually become unavailable */ - public function templateFilesRequest($template_id, $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) + public function templateFilesRequest(string $template_id, string $file_type = null, string $contentType = self::contentTypes['templateFiles'][0]) { - // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_id when calling templateFiles' ); } - - $resourcePath = '/template/files/{template_id}'; $formParams = []; $queryParams = []; @@ -1773,19 +1714,17 @@ public function templateFilesRequest($template_id, $file_type = null, string $co false // required ) ?? []); - // path params if ($template_id !== null) { $resourcePath = str_replace( - '{' . 'template_id' . '}', + '{template_id}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/zip', 'application/json', ], + $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/zip', 'application/json'], $contentType, $multipart ); @@ -1799,7 +1738,7 @@ public function templateFilesRequest($template_id, $file_type = null, string $co foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1813,9 +1752,8 @@ public function templateFilesRequest($template_id, $file_type = null, string $co } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1858,13 +1796,13 @@ public function templateFilesRequest($template_id, $file_type = null, string $co * * Get Template Files as Data Uri * - * @param string $template_id The id of the template files to retrieve. (required) + * @param string $template_id The id of the template files to retrieve. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FileResponseDataUri|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FileResponseDataUri + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateFilesAsDataUri($template_id) + public function templateFilesAsDataUri(string $template_id) { list($response) = $this->templateFilesAsDataUriWithHttpInfo($template_id); return $response; @@ -1875,15 +1813,15 @@ public function templateFilesAsDataUri($template_id) * * Get Template Files as Data Uri * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FileResponseDataUri|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FileResponseDataUri, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsDataUri. This method will eventually become unavailable */ - public function templateFilesAsDataUriWithHttpInfo($template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) + public function templateFilesAsDataUriWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) { $request = $this->templateFilesAsDataUriRequest($template_id, $contentType); @@ -1895,14 +1833,14 @@ public function templateFilesAsDataUriWithHttpInfo($template_id, string $content } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1915,14 +1853,14 @@ public function templateFilesAsDataUriWithHttpInfo($template_id, string $content sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1931,18 +1869,17 @@ public function templateFilesAsDataUriWithHttpInfo($template_id, string $content if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FileResponseDataUri' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FileResponseDataUri' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1959,20 +1896,19 @@ public function templateFilesAsDataUriWithHttpInfo($template_id, string $content return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FileResponseDataUri', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FileResponseDataUri'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1989,11 +1925,9 @@ public function templateFilesAsDataUriWithHttpInfo($template_id, string $content return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2006,7 +1940,6 @@ public function templateFilesAsDataUriWithHttpInfo($template_id, string $content ); $e->setResponseObject($data); break; - } throw $e; } @@ -2017,14 +1950,14 @@ public function templateFilesAsDataUriWithHttpInfo($template_id, string $content * * Get Template Files as Data Uri * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsDataUri. This method will eventually become unavailable */ - public function templateFilesAsDataUriAsync($template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) + public function templateFilesAsDataUriAsync(string $template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) { return $this->templateFilesAsDataUriAsyncWithHttpInfo($template_id, $contentType) ->then( @@ -2039,14 +1972,14 @@ function ($response) { * * Get Template Files as Data Uri * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsDataUri. This method will eventually become unavailable */ - public function templateFilesAsDataUriAsyncWithHttpInfo($template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) + public function templateFilesAsDataUriAsyncWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) { $returnType = '\Dropbox\Sign\Model\FileResponseDataUri'; $request = $this->templateFilesAsDataUriRequest($template_id, $contentType); @@ -2056,9 +1989,9 @@ public function templateFilesAsDataUriAsyncWithHttpInfo($template_id, string $co ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2067,7 +2000,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2081,7 +2014,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2090,24 +2023,22 @@ function ($exception) { /** * Create request for operation 'templateFilesAsDataUri' * - * @param string $template_id The id of the template files to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsDataUri. This method will eventually become unavailable */ - public function templateFilesAsDataUriRequest($template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) + public function templateFilesAsDataUriRequest(string $template_id, string $contentType = self::contentTypes['templateFilesAsDataUri'][0]) { - // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_id when calling templateFilesAsDataUri' ); } - $resourcePath = '/template/files_as_data_uri/{template_id}'; $formParams = []; $queryParams = []; @@ -2115,20 +2046,17 @@ public function templateFilesAsDataUriRequest($template_id, string $contentType $httpBody = ''; $multipart = false; - - // path params if ($template_id !== null) { $resourcePath = str_replace( - '{' . 'template_id' . '}', + '{template_id}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -2142,7 +2070,7 @@ public function templateFilesAsDataUriRequest($template_id, string $contentType foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2156,9 +2084,8 @@ public function templateFilesAsDataUriRequest($template_id, string $contentType } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2201,14 +2128,14 @@ public function templateFilesAsDataUriRequest($template_id, string $contentType * * Get Template Files as File Url * - * @param string $template_id The id of the template files to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $template_id The id of the template files to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\FileResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\FileResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateFilesAsFileUrl($template_id, $force_download = 1) + public function templateFilesAsFileUrl(string $template_id, int $force_download = 1) { list($response) = $this->templateFilesAsFileUrlWithHttpInfo($template_id, $force_download); return $response; @@ -2219,16 +2146,16 @@ public function templateFilesAsFileUrl($template_id, $force_download = 1) * * Get Template Files as File Url * - * @param string $template_id The id of the template files to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\FileResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\FileResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsFileUrl. This method will eventually become unavailable */ - public function templateFilesAsFileUrlWithHttpInfo($template_id, $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) + public function templateFilesAsFileUrlWithHttpInfo(string $template_id, int $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) { $request = $this->templateFilesAsFileUrlRequest($template_id, $force_download, $contentType); @@ -2240,14 +2167,14 @@ public function templateFilesAsFileUrlWithHttpInfo($template_id, $force_download } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -2260,14 +2187,14 @@ public function templateFilesAsFileUrlWithHttpInfo($template_id, $force_download sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2276,18 +2203,17 @@ public function templateFilesAsFileUrlWithHttpInfo($template_id, $force_download if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\FileResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\FileResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2304,20 +2230,19 @@ public function templateFilesAsFileUrlWithHttpInfo($template_id, $force_download return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FileResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\FileResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2334,11 +2259,9 @@ public function templateFilesAsFileUrlWithHttpInfo($template_id, $force_download return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2351,7 +2274,6 @@ public function templateFilesAsFileUrlWithHttpInfo($template_id, $force_download ); $e->setResponseObject($data); break; - } throw $e; } @@ -2362,15 +2284,15 @@ public function templateFilesAsFileUrlWithHttpInfo($template_id, $force_download * * Get Template Files as File Url * - * @param string $template_id The id of the template files to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsFileUrl. This method will eventually become unavailable */ - public function templateFilesAsFileUrlAsync($template_id, $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) + public function templateFilesAsFileUrlAsync(string $template_id, int $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) { return $this->templateFilesAsFileUrlAsyncWithHttpInfo($template_id, $force_download, $contentType) ->then( @@ -2385,15 +2307,15 @@ function ($response) { * * Get Template Files as File Url * - * @param string $template_id The id of the template files to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsFileUrl. This method will eventually become unavailable */ - public function templateFilesAsFileUrlAsyncWithHttpInfo($template_id, $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) + public function templateFilesAsFileUrlAsyncWithHttpInfo(string $template_id, int $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) { $returnType = '\Dropbox\Sign\Model\FileResponse'; $request = $this->templateFilesAsFileUrlRequest($template_id, $force_download, $contentType); @@ -2403,9 +2325,9 @@ public function templateFilesAsFileUrlAsyncWithHttpInfo($template_id, $force_dow ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2414,7 +2336,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2428,7 +2350,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2437,26 +2359,23 @@ function ($exception) { /** * Create request for operation 'templateFilesAsFileUrl' * - * @param string $template_id The id of the template files to retrieve. (required) - * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation + * @param string $template_id The id of the template files to retrieve. (required) + * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateFilesAsFileUrl. This method will eventually become unavailable */ - public function templateFilesAsFileUrlRequest($template_id, $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) + public function templateFilesAsFileUrlRequest(string $template_id, int $force_download = 1, string $contentType = self::contentTypes['templateFilesAsFileUrl'][0]) { - // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_id when calling templateFilesAsFileUrl' ); } - - $resourcePath = '/template/files_as_file_url/{template_id}'; $formParams = []; $queryParams = []; @@ -2474,19 +2393,17 @@ public function templateFilesAsFileUrlRequest($template_id, $force_download = 1, false // required ) ?? []); - // path params if ($template_id !== null) { $resourcePath = str_replace( - '{' . 'template_id' . '}', + '{template_id}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -2500,7 +2417,7 @@ public function templateFilesAsFileUrlRequest($template_id, $force_download = 1, foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2514,9 +2431,8 @@ public function templateFilesAsFileUrlRequest($template_id, $force_download = 1, } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2559,13 +2475,13 @@ public function templateFilesAsFileUrlRequest($template_id, $force_download = 1, * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) + * @param string $template_id The id of the Template to retrieve. (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TemplateGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateGet($template_id) + public function templateGet(string $template_id) { list($response) = $this->templateGetWithHttpInfo($template_id); return $response; @@ -2576,15 +2492,15 @@ public function templateGet($template_id) * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TemplateGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetWithHttpInfo($template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) { $request = $this->templateGetRequest($template_id, $contentType); @@ -2596,14 +2512,14 @@ public function templateGetWithHttpInfo($template_id, string $contentType = self } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -2616,14 +2532,14 @@ public function templateGetWithHttpInfo($template_id, string $contentType = self sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2632,18 +2548,17 @@ public function templateGetWithHttpInfo($template_id, string $contentType = self if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TemplateGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2660,20 +2575,19 @@ public function templateGetWithHttpInfo($template_id, string $contentType = self return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -2690,11 +2604,9 @@ public function templateGetWithHttpInfo($template_id, string $contentType = self return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -2707,7 +2619,6 @@ public function templateGetWithHttpInfo($template_id, string $contentType = self ); $e->setResponseObject($data); break; - } throw $e; } @@ -2718,14 +2629,14 @@ public function templateGetWithHttpInfo($template_id, string $contentType = self * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetAsync($template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetAsync(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) { return $this->templateGetAsyncWithHttpInfo($template_id, $contentType) ->then( @@ -2740,14 +2651,14 @@ function ($response) { * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetAsyncWithHttpInfo($template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetAsyncWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; $request = $this->templateGetRequest($template_id, $contentType); @@ -2757,9 +2668,9 @@ public function templateGetAsyncWithHttpInfo($template_id, string $contentType = ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -2768,7 +2679,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -2782,7 +2693,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -2791,24 +2702,22 @@ function ($exception) { /** * Create request for operation 'templateGet' * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetRequest($template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetRequest(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) { - // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_id when calling templateGet' ); } - $resourcePath = '/template/{template_id}'; $formParams = []; $queryParams = []; @@ -2816,20 +2725,17 @@ public function templateGetRequest($template_id, string $contentType = self::con $httpBody = ''; $multipart = false; - - // path params if ($template_id !== null) { $resourcePath = str_replace( - '{' . 'template_id' . '}', + '{template_id}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -2843,7 +2749,7 @@ public function templateGetRequest($template_id, string $contentType = self::con foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -2857,9 +2763,8 @@ public function templateGetRequest($template_id, string $contentType = self::con } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -2902,16 +2807,16 @@ public function templateGetRequest($template_id, string $contentType = self::con * * List Templates * - * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) + * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TemplateListResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TemplateListResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateList($account_id = null, $page = 1, $page_size = 20, $query = null) + public function templateList(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null) { list($response) = $this->templateListWithHttpInfo($account_id, $page, $page_size, $query); return $response; @@ -2922,18 +2827,18 @@ public function templateList($account_id = null, $page = 1, $page_size = 20, $qu * * List Templates * - * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation + * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TemplateListResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TemplateListResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateList. This method will eventually become unavailable */ - public function templateListWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['templateList'][0]) + public function templateListWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['templateList'][0]) { $request = $this->templateListRequest($account_id, $page, $page_size, $query, $contentType); @@ -2945,14 +2850,14 @@ public function templateListWithHttpInfo($account_id = null, $page = 1, $page_si } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -2965,14 +2870,14 @@ public function templateListWithHttpInfo($account_id = null, $page = 1, $page_si sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -2981,18 +2886,17 @@ public function templateListWithHttpInfo($account_id = null, $page = 1, $page_si if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateListResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TemplateListResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3009,20 +2913,19 @@ public function templateListWithHttpInfo($account_id = null, $page = 1, $page_si return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateListResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TemplateListResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3039,11 +2942,9 @@ public function templateListWithHttpInfo($account_id = null, $page = 1, $page_si return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3056,7 +2957,6 @@ public function templateListWithHttpInfo($account_id = null, $page = 1, $page_si ); $e->setResponseObject($data); break; - } throw $e; } @@ -3067,17 +2967,17 @@ public function templateListWithHttpInfo($account_id = null, $page = 1, $page_si * * List Templates * - * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation + * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateList. This method will eventually become unavailable */ - public function templateListAsync($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['templateList'][0]) + public function templateListAsync(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['templateList'][0]) { return $this->templateListAsyncWithHttpInfo($account_id, $page, $page_size, $query, $contentType) ->then( @@ -3092,17 +2992,17 @@ function ($response) { * * List Templates * - * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation + * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateList. This method will eventually become unavailable */ - public function templateListAsyncWithHttpInfo($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['templateList'][0]) + public function templateListAsyncWithHttpInfo(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['templateList'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateListResponse'; $request = $this->templateListRequest($account_id, $page, $page_size, $query, $contentType); @@ -3112,9 +3012,9 @@ public function templateListAsyncWithHttpInfo($account_id = null, $page = 1, $pa ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3123,7 +3023,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -3137,7 +3037,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -3146,29 +3046,24 @@ function ($exception) { /** * Create request for operation 'templateList' * - * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) - * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) - * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) - * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation + * @param string $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) + * @param int $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param string $query String that includes search terms and/or fields to be used to filter the Template objects. (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateList'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateList. This method will eventually become unavailable */ - public function templateListRequest($account_id = null, $page = 1, $page_size = 20, $query = null, string $contentType = self::contentTypes['templateList'][0]) + public function templateListRequest(string $account_id = null, int $page = 1, int $page_size = 20, string $query = null, string $contentType = self::contentTypes['templateList'][0]) { - - - if ($page_size !== null && $page_size > 100) { - throw new \InvalidArgumentException('invalid value for "$page_size" when calling TemplateApi.templateList, must be smaller than or equal to 100.'); + throw new InvalidArgumentException('invalid value for "$page_size" when calling TemplateApi.templateList, must be smaller than or equal to 100.'); } if ($page_size !== null && $page_size < 1) { - throw new \InvalidArgumentException('invalid value for "$page_size" when calling TemplateApi.templateList, must be bigger than or equal to 1.'); + throw new InvalidArgumentException('invalid value for "$page_size" when calling TemplateApi.templateList, must be bigger than or equal to 1.'); } - - $resourcePath = '/template/list'; $formParams = []; @@ -3214,11 +3109,8 @@ public function templateListRequest($account_id = null, $page = 1, $page_size = false // required ) ?? []); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -3232,7 +3124,7 @@ public function templateListRequest($account_id = null, $page = 1, $page_size = foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -3246,9 +3138,8 @@ public function templateListRequest($account_id = null, $page = 1, $page_size = } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3291,14 +3182,14 @@ public function templateListRequest($account_id = null, $page = 1, $page_size = * * Remove User from Template * - * @param string $template_id The id of the Template to remove the Account's access to. (required) - * @param \Dropbox\Sign\Model\TemplateRemoveUserRequest $template_remove_user_request template_remove_user_request (required) + * @param string $template_id The id of the Template to remove the Account's access to. (required) + * @param Model\TemplateRemoveUserRequest $template_remove_user_request template_remove_user_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TemplateGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateRemoveUser($template_id, $template_remove_user_request) + public function templateRemoveUser(string $template_id, Model\TemplateRemoveUserRequest $template_remove_user_request) { list($response) = $this->templateRemoveUserWithHttpInfo($template_id, $template_remove_user_request); return $response; @@ -3309,16 +3200,16 @@ public function templateRemoveUser($template_id, $template_remove_user_request) * * Remove User from Template * - * @param string $template_id The id of the Template to remove the Account's access to. (required) - * @param \Dropbox\Sign\Model\TemplateRemoveUserRequest $template_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to remove the Account's access to. (required) + * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TemplateGetResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TemplateGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateRemoveUser. This method will eventually become unavailable */ - public function templateRemoveUserWithHttpInfo($template_id, $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) + public function templateRemoveUserWithHttpInfo(string $template_id, Model\TemplateRemoveUserRequest $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) { $request = $this->templateRemoveUserRequest($template_id, $template_remove_user_request, $contentType); @@ -3330,14 +3221,14 @@ public function templateRemoveUserWithHttpInfo($template_id, $template_remove_us } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -3350,14 +3241,14 @@ public function templateRemoveUserWithHttpInfo($template_id, $template_remove_us sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3366,18 +3257,17 @@ public function templateRemoveUserWithHttpInfo($template_id, $template_remove_us if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateGetResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TemplateGetResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3394,20 +3284,19 @@ public function templateRemoveUserWithHttpInfo($template_id, $template_remove_us return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateGetResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3424,11 +3313,9 @@ public function templateRemoveUserWithHttpInfo($template_id, $template_remove_us return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3441,7 +3328,6 @@ public function templateRemoveUserWithHttpInfo($template_id, $template_remove_us ); $e->setResponseObject($data); break; - } throw $e; } @@ -3452,15 +3338,15 @@ public function templateRemoveUserWithHttpInfo($template_id, $template_remove_us * * Remove User from Template * - * @param string $template_id The id of the Template to remove the Account's access to. (required) - * @param \Dropbox\Sign\Model\TemplateRemoveUserRequest $template_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to remove the Account's access to. (required) + * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateRemoveUser. This method will eventually become unavailable */ - public function templateRemoveUserAsync($template_id, $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) + public function templateRemoveUserAsync(string $template_id, Model\TemplateRemoveUserRequest $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) { return $this->templateRemoveUserAsyncWithHttpInfo($template_id, $template_remove_user_request, $contentType) ->then( @@ -3475,15 +3361,15 @@ function ($response) { * * Remove User from Template * - * @param string $template_id The id of the Template to remove the Account's access to. (required) - * @param \Dropbox\Sign\Model\TemplateRemoveUserRequest $template_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to remove the Account's access to. (required) + * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateRemoveUser. This method will eventually become unavailable */ - public function templateRemoveUserAsyncWithHttpInfo($template_id, $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) + public function templateRemoveUserAsyncWithHttpInfo(string $template_id, Model\TemplateRemoveUserRequest $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; $request = $this->templateRemoveUserRequest($template_id, $template_remove_user_request, $contentType); @@ -3493,9 +3379,9 @@ public function templateRemoveUserAsyncWithHttpInfo($template_id, $template_remo ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3504,7 +3390,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -3518,7 +3404,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -3527,32 +3413,30 @@ function ($exception) { /** * Create request for operation 'templateRemoveUser' * - * @param string $template_id The id of the Template to remove the Account's access to. (required) - * @param \Dropbox\Sign\Model\TemplateRemoveUserRequest $template_remove_user_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation + * @param string $template_id The id of the Template to remove the Account's access to. (required) + * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateRemoveUser. This method will eventually become unavailable */ - public function templateRemoveUserRequest($template_id, $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) + public function templateRemoveUserRequest(string $template_id, Model\TemplateRemoveUserRequest $template_remove_user_request, string $contentType = self::contentTypes['templateRemoveUser'][0]) { - // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_id when calling templateRemoveUser' ); } // verify the required parameter 'template_remove_user_request' is set if ($template_remove_user_request === null || (is_array($template_remove_user_request) && count($template_remove_user_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_remove_user_request when calling templateRemoveUser' ); } - $resourcePath = '/template/remove_user/{template_id}'; $formParams = []; $queryParams = []; @@ -3566,19 +3450,17 @@ public function templateRemoveUserRequest($template_id, $template_remove_user_re $multipart = !empty($formParams); - // path params if ($template_id !== null) { $resourcePath = str_replace( - '{' . 'template_id' . '}', + '{template_id}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -3586,7 +3468,7 @@ public function templateRemoveUserRequest($template_id, $template_remove_user_re // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_remove_user_request)); } else { $httpBody = $template_remove_user_request; @@ -3599,7 +3481,7 @@ public function templateRemoveUserRequest($template_id, $template_remove_user_re foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -3616,9 +3498,8 @@ public function templateRemoveUserRequest($template_id, $template_remove_user_re $payloadHook('multipart', $multipartContents, $template_remove_user_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -3661,14 +3542,14 @@ public function templateRemoveUserRequest($template_id, $template_remove_user_re * * Update Template Files * - * @param string $template_id The ID of the template whose files to update. (required) - * @param \Dropbox\Sign\Model\TemplateUpdateFilesRequest $template_update_files_request template_update_files_request (required) + * @param string $template_id The ID of the template whose files to update. (required) + * @param Model\TemplateUpdateFilesRequest $template_update_files_request template_update_files_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\TemplateUpdateFilesResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\TemplateUpdateFilesResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function templateUpdateFiles($template_id, $template_update_files_request) + public function templateUpdateFiles(string $template_id, Model\TemplateUpdateFilesRequest $template_update_files_request) { list($response) = $this->templateUpdateFilesWithHttpInfo($template_id, $template_update_files_request); return $response; @@ -3679,16 +3560,16 @@ public function templateUpdateFiles($template_id, $template_update_files_request * * Update Template Files * - * @param string $template_id The ID of the template whose files to update. (required) - * @param \Dropbox\Sign\Model\TemplateUpdateFilesRequest $template_update_files_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation + * @param string $template_id The ID of the template whose files to update. (required) + * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\TemplateUpdateFilesResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\TemplateUpdateFilesResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateUpdateFiles. This method will eventually become unavailable */ - public function templateUpdateFilesWithHttpInfo($template_id, $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) + public function templateUpdateFilesWithHttpInfo(string $template_id, Model\TemplateUpdateFilesRequest $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) { $request = $this->templateUpdateFilesRequest($template_id, $template_update_files_request, $contentType); @@ -3700,14 +3581,14 @@ public function templateUpdateFilesWithHttpInfo($template_id, $template_update_f } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -3720,14 +3601,14 @@ public function templateUpdateFilesWithHttpInfo($template_id, $template_update_f sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -3736,18 +3617,17 @@ public function templateUpdateFilesWithHttpInfo($template_id, $template_update_f if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\TemplateUpdateFilesResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\TemplateUpdateFilesResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3764,20 +3644,19 @@ public function templateUpdateFilesWithHttpInfo($template_id, $template_update_f return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateUpdateFilesResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\TemplateUpdateFilesResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -3794,11 +3673,9 @@ public function templateUpdateFilesWithHttpInfo($template_id, $template_update_f return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -3811,7 +3688,6 @@ public function templateUpdateFilesWithHttpInfo($template_id, $template_update_f ); $e->setResponseObject($data); break; - } throw $e; } @@ -3822,15 +3698,15 @@ public function templateUpdateFilesWithHttpInfo($template_id, $template_update_f * * Update Template Files * - * @param string $template_id The ID of the template whose files to update. (required) - * @param \Dropbox\Sign\Model\TemplateUpdateFilesRequest $template_update_files_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation + * @param string $template_id The ID of the template whose files to update. (required) + * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateUpdateFiles. This method will eventually become unavailable */ - public function templateUpdateFilesAsync($template_id, $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) + public function templateUpdateFilesAsync(string $template_id, Model\TemplateUpdateFilesRequest $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) { return $this->templateUpdateFilesAsyncWithHttpInfo($template_id, $template_update_files_request, $contentType) ->then( @@ -3845,15 +3721,15 @@ function ($response) { * * Update Template Files * - * @param string $template_id The ID of the template whose files to update. (required) - * @param \Dropbox\Sign\Model\TemplateUpdateFilesRequest $template_update_files_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation + * @param string $template_id The ID of the template whose files to update. (required) + * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateUpdateFiles. This method will eventually become unavailable */ - public function templateUpdateFilesAsyncWithHttpInfo($template_id, $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) + public function templateUpdateFilesAsyncWithHttpInfo(string $template_id, Model\TemplateUpdateFilesRequest $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateUpdateFilesResponse'; $request = $this->templateUpdateFilesRequest($template_id, $template_update_files_request, $contentType); @@ -3863,9 +3739,9 @@ public function templateUpdateFilesAsyncWithHttpInfo($template_id, $template_upd ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -3874,7 +3750,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -3888,7 +3764,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -3897,32 +3773,30 @@ function ($exception) { /** * Create request for operation 'templateUpdateFiles' * - * @param string $template_id The ID of the template whose files to update. (required) - * @param \Dropbox\Sign\Model\TemplateUpdateFilesRequest $template_update_files_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation + * @param string $template_id The ID of the template whose files to update. (required) + * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::templateUpdateFiles. This method will eventually become unavailable */ - public function templateUpdateFilesRequest($template_id, $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) + public function templateUpdateFilesRequest(string $template_id, Model\TemplateUpdateFilesRequest $template_update_files_request, string $contentType = self::contentTypes['templateUpdateFiles'][0]) { - // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_id when calling templateUpdateFiles' ); } // verify the required parameter 'template_update_files_request' is set if ($template_update_files_request === null || (is_array($template_update_files_request) && count($template_update_files_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $template_update_files_request when calling templateUpdateFiles' ); } - $resourcePath = '/template/update_files/{template_id}'; $formParams = []; $queryParams = []; @@ -3936,19 +3810,17 @@ public function templateUpdateFilesRequest($template_id, $template_update_files_ $multipart = !empty($formParams); - // path params if ($template_id !== null) { $resourcePath = str_replace( - '{' . 'template_id' . '}', + '{template_id}', ObjectSerializer::toPathValue($template_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -3956,7 +3828,7 @@ public function templateUpdateFilesRequest($template_id, $template_update_files_ // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_update_files_request)); } else { $httpBody = $template_update_files_request; @@ -3969,7 +3841,7 @@ public function templateUpdateFilesRequest($template_id, $template_update_files_ foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -3986,9 +3858,8 @@ public function templateUpdateFilesRequest($template_id, $template_update_files_ $payloadHook('multipart', $multipartContents, $template_update_files_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -4029,8 +3900,8 @@ public function templateUpdateFilesRequest($template_id, $template_update_files_ /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -4038,7 +3909,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -4054,8 +3925,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -4065,9 +3936,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -4086,8 +3957,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/Api/UnclaimedDraftApi.php b/sdks/php/src/Api/UnclaimedDraftApi.php index 3e8297f9a..3886a87c5 100644 --- a/sdks/php/src/Api/UnclaimedDraftApi.php +++ b/sdks/php/src/Api/UnclaimedDraftApi.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,6 +26,11 @@ namespace Dropbox\Sign\Api; +use Dropbox\Sign\ApiException; +use Dropbox\Sign\Configuration; +use Dropbox\Sign\HeaderSelector; +use Dropbox\Sign\Model; +use Dropbox\Sign\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; @@ -35,44 +38,34 @@ use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Dropbox\Sign\ApiException; -use Dropbox\Sign\Configuration; -use Dropbox\Sign\HeaderSelector; -use Dropbox\Sign\ObjectSerializer; -use Dropbox\Sign\Model; +use InvalidArgumentException; +use JsonException; use Psr\Http\Message\ResponseInterface; +use RuntimeException; /** * UnclaimedDraftApi Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class UnclaimedDraftApi { - /** - * @var ClientInterface - */ + /** @var ClientInterface */ protected $client; - /** - * @var Configuration - */ + /** @var Configuration */ protected $config; - /** - * @var HeaderSelector - */ + /** @var HeaderSelector */ protected $headerSelector; - /** - * @var int Host index - */ + /** @var int Host index */ protected $hostIndex; - /** @var string[] $contentTypes **/ + /** + * @var string[] * + */ public const contentTypes = [ 'unclaimedDraftCreate' => [ 'application/json', @@ -95,16 +88,13 @@ class UnclaimedDraftApi protected $response; /** - * @param Configuration $config - * @param ClientInterface $client - * @param HeaderSelector $selector - * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( Configuration $config = null, ClientInterface $client = null, HeaderSelector $selector = null, - $hostIndex = 0 + int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); @@ -118,7 +108,7 @@ public function __construct( * @param int $hostIndex Host index (required) * @deprecated To be made private in the future */ - public function setHostIndex($hostIndex): void + public function setHostIndex(int $hostIndex): void { $this->hostIndex = $hostIndex; } @@ -155,13 +145,13 @@ public function getResponse() * * Create Unclaimed Draft * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request unclaimed_draft_create_request (required) + * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request unclaimed_draft_create_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\UnclaimedDraftCreateResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function unclaimedDraftCreate($unclaimed_draft_create_request) + public function unclaimedDraftCreate(Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request) { list($response) = $this->unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request); return $response; @@ -172,15 +162,15 @@ public function unclaimedDraftCreate($unclaimed_draft_create_request) * * Create Unclaimed Draft * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\UnclaimedDraftCreateResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreate. This method will eventually become unavailable */ - public function unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) + public function unclaimedDraftCreateWithHttpInfo(Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) { $request = $this->unclaimedDraftCreateRequest($unclaimed_draft_create_request, $contentType); @@ -192,14 +182,14 @@ public function unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -212,14 +202,14 @@ public function unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -228,18 +218,17 @@ public function unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -256,20 +245,19 @@ public function unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -286,11 +274,9 @@ public function unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -303,7 +289,6 @@ public function unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request ); $e->setResponseObject($data); break; - } throw $e; } @@ -314,14 +299,14 @@ public function unclaimedDraftCreateWithHttpInfo($unclaimed_draft_create_request * * Create Unclaimed Draft * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreate. This method will eventually become unavailable */ - public function unclaimedDraftCreateAsync($unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) + public function unclaimedDraftCreateAsync(Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) { return $this->unclaimedDraftCreateAsyncWithHttpInfo($unclaimed_draft_create_request, $contentType) ->then( @@ -336,14 +321,14 @@ function ($response) { * * Create Unclaimed Draft * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreate. This method will eventually become unavailable */ - public function unclaimedDraftCreateAsyncWithHttpInfo($unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) + public function unclaimedDraftCreateAsyncWithHttpInfo(Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) { $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; $request = $this->unclaimedDraftCreateRequest($unclaimed_draft_create_request, $contentType); @@ -353,9 +338,9 @@ public function unclaimedDraftCreateAsyncWithHttpInfo($unclaimed_draft_create_re ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -364,7 +349,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -378,7 +363,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -387,24 +372,22 @@ function ($exception) { /** * Create request for operation 'unclaimedDraftCreate' * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreate. This method will eventually become unavailable */ - public function unclaimedDraftCreateRequest($unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) + public function unclaimedDraftCreateRequest(Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request, string $contentType = self::contentTypes['unclaimedDraftCreate'][0]) { - // verify the required parameter 'unclaimed_draft_create_request' is set if ($unclaimed_draft_create_request === null || (is_array($unclaimed_draft_create_request) && count($unclaimed_draft_create_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $unclaimed_draft_create_request when calling unclaimedDraftCreate' ); } - $resourcePath = '/unclaimed_draft/create'; $formParams = []; $queryParams = []; @@ -418,11 +401,8 @@ public function unclaimedDraftCreateRequest($unclaimed_draft_create_request, str $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -430,7 +410,7 @@ public function unclaimedDraftCreateRequest($unclaimed_draft_create_request, str // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($unclaimed_draft_create_request)); } else { $httpBody = $unclaimed_draft_create_request; @@ -443,7 +423,7 @@ public function unclaimedDraftCreateRequest($unclaimed_draft_create_request, str foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -460,9 +440,8 @@ public function unclaimedDraftCreateRequest($unclaimed_draft_create_request, str $payloadHook('multipart', $multipartContents, $unclaimed_draft_create_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -505,13 +484,13 @@ public function unclaimedDraftCreateRequest($unclaimed_draft_create_request, str * * Create Embedded Unclaimed Draft * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request unclaimed_draft_create_embedded_request (required) + * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request unclaimed_draft_create_embedded_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\UnclaimedDraftCreateResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function unclaimedDraftCreateEmbedded($unclaimed_draft_create_embedded_request) + public function unclaimedDraftCreateEmbedded(Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request) { list($response) = $this->unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create_embedded_request); return $response; @@ -522,15 +501,15 @@ public function unclaimedDraftCreateEmbedded($unclaimed_draft_create_embedded_re * * Create Embedded Unclaimed Draft * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\UnclaimedDraftCreateResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbedded. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) + public function unclaimedDraftCreateEmbeddedWithHttpInfo(Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) { $request = $this->unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embedded_request, $contentType); @@ -542,14 +521,14 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -562,14 +541,14 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -578,18 +557,17 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -606,20 +584,19 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -636,11 +613,9 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -653,7 +628,6 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create ); $e->setResponseObject($data); break; - } throw $e; } @@ -664,14 +638,14 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo($unclaimed_draft_create * * Create Embedded Unclaimed Draft * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbedded. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedAsync($unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) + public function unclaimedDraftCreateEmbeddedAsync(Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) { return $this->unclaimedDraftCreateEmbeddedAsyncWithHttpInfo($unclaimed_draft_create_embedded_request, $contentType) ->then( @@ -686,14 +660,14 @@ function ($response) { * * Create Embedded Unclaimed Draft * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbedded. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedAsyncWithHttpInfo($unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) + public function unclaimedDraftCreateEmbeddedAsyncWithHttpInfo(Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) { $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; $request = $this->unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embedded_request, $contentType); @@ -703,9 +677,9 @@ public function unclaimedDraftCreateEmbeddedAsyncWithHttpInfo($unclaimed_draft_c ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -714,7 +688,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -728,7 +702,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -737,24 +711,22 @@ function ($exception) { /** * Create request for operation 'unclaimedDraftCreateEmbedded' * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbedded. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) + public function unclaimedDraftCreateEmbeddedRequest(Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbedded'][0]) { - // verify the required parameter 'unclaimed_draft_create_embedded_request' is set if ($unclaimed_draft_create_embedded_request === null || (is_array($unclaimed_draft_create_embedded_request) && count($unclaimed_draft_create_embedded_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $unclaimed_draft_create_embedded_request when calling unclaimedDraftCreateEmbedded' ); } - $resourcePath = '/unclaimed_draft/create_embedded'; $formParams = []; $queryParams = []; @@ -768,11 +740,8 @@ public function unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embe $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -780,7 +749,7 @@ public function unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embe // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($unclaimed_draft_create_embedded_request)); } else { $httpBody = $unclaimed_draft_create_embedded_request; @@ -793,7 +762,7 @@ public function unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embe foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -810,9 +779,8 @@ public function unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embe $payloadHook('multipart', $multipartContents, $unclaimed_draft_create_embedded_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -855,13 +823,13 @@ public function unclaimedDraftCreateEmbeddedRequest($unclaimed_draft_create_embe * * Create Embedded Unclaimed Draft with Template * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request unclaimed_draft_create_embedded_with_template_request (required) + * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request unclaimed_draft_create_embedded_with_template_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\UnclaimedDraftCreateResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function unclaimedDraftCreateEmbeddedWithTemplate($unclaimed_draft_create_embedded_with_template_request) + public function unclaimedDraftCreateEmbeddedWithTemplate(Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request) { list($response) = $this->unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_draft_create_embedded_with_template_request); return $response; @@ -872,15 +840,15 @@ public function unclaimedDraftCreateEmbeddedWithTemplate($unclaimed_draft_create * * Create Embedded Unclaimed Draft with Template * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\UnclaimedDraftCreateResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) + public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) { $request = $this->unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft_create_embedded_with_template_request, $contentType); @@ -892,14 +860,14 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -912,14 +880,14 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -928,18 +896,17 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_ if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -956,20 +923,19 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -986,11 +952,9 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1003,7 +967,6 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_ ); $e->setResponseObject($data); break; - } throw $e; } @@ -1014,14 +977,14 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo($unclaimed_ * * Create Embedded Unclaimed Draft with Template * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedWithTemplateAsync($unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) + public function unclaimedDraftCreateEmbeddedWithTemplateAsync(Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) { return $this->unclaimedDraftCreateEmbeddedWithTemplateAsyncWithHttpInfo($unclaimed_draft_create_embedded_with_template_request, $contentType) ->then( @@ -1036,14 +999,14 @@ function ($response) { * * Create Embedded Unclaimed Draft with Template * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedWithTemplateAsyncWithHttpInfo($unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) + public function unclaimedDraftCreateEmbeddedWithTemplateAsyncWithHttpInfo(Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) { $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; $request = $this->unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft_create_embedded_with_template_request, $contentType); @@ -1053,9 +1016,9 @@ public function unclaimedDraftCreateEmbeddedWithTemplateAsyncWithHttpInfo($uncla ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1064,7 +1027,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1078,7 +1041,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1087,24 +1050,22 @@ function ($exception) { /** * Create request for operation 'unclaimedDraftCreateEmbeddedWithTemplate' * - * @param \Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation + * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftCreateEmbeddedWithTemplate. This method will eventually become unavailable */ - public function unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) + public function unclaimedDraftCreateEmbeddedWithTemplateRequest(Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request, string $contentType = self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'][0]) { - // verify the required parameter 'unclaimed_draft_create_embedded_with_template_request' is set if ($unclaimed_draft_create_embedded_with_template_request === null || (is_array($unclaimed_draft_create_embedded_with_template_request) && count($unclaimed_draft_create_embedded_with_template_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $unclaimed_draft_create_embedded_with_template_request when calling unclaimedDraftCreateEmbeddedWithTemplate' ); } - $resourcePath = '/unclaimed_draft/create_embedded_with_template'; $formParams = []; $queryParams = []; @@ -1118,11 +1079,8 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft $multipart = !empty($formParams); - - - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1130,7 +1088,7 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($unclaimed_draft_create_embedded_with_template_request)); } else { $httpBody = $unclaimed_draft_create_embedded_with_template_request; @@ -1143,7 +1101,7 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1160,9 +1118,8 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft $payloadHook('multipart', $multipartContents, $unclaimed_draft_create_embedded_with_template_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1205,14 +1162,14 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest($unclaimed_draft * * Edit and Resend Unclaimed Draft * - * @param string $signature_request_id The ID of the signature request to edit and resend. (required) - * @param \Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request unclaimed_draft_edit_and_resend_request (required) + * @param string $signature_request_id The ID of the signature request to edit and resend. (required) + * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request unclaimed_draft_edit_and_resend_request (required) * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse + * @return Model\UnclaimedDraftCreateResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException */ - public function unclaimedDraftEditAndResend($signature_request_id, $unclaimed_draft_edit_and_resend_request) + public function unclaimedDraftEditAndResend(string $signature_request_id, Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request) { list($response) = $this->unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $unclaimed_draft_edit_and_resend_request); return $response; @@ -1223,16 +1180,16 @@ public function unclaimedDraftEditAndResend($signature_request_id, $unclaimed_dr * * Edit and Resend Unclaimed Draft * - * @param string $signature_request_id The ID of the signature request to edit and resend. (required) - * @param \Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation + * @param string $signature_request_id The ID of the signature request to edit and resend. (required) + * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation * - * @throws \Dropbox\Sign\ApiException on non-2xx response or if the response body is not in the expected format - * @throws \InvalidArgumentException - * @return array of \Dropbox\Sign\Model\UnclaimedDraftCreateResponse|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of Model\UnclaimedDraftCreateResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftEditAndResend. This method will eventually become unavailable */ - public function unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) + public function unclaimedDraftEditAndResendWithHttpInfo(string $signature_request_id, Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) { $request = $this->unclaimedDraftEditAndResendRequest($signature_request_id, $unclaimed_draft_edit_and_resend_request, $contentType); @@ -1244,14 +1201,14 @@ public function unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $ } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, - $e->getResponse() ? (string) $e->getResponse()->getBody() : null + $e->getResponse() ? (string)$e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", - (int) $e->getCode(), + (int)$e->getCode(), null, null ); @@ -1264,14 +1221,14 @@ public function unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $ sprintf( '[%d] Error connecting to the API (%s)', $statusCode, - (string) $request->getUri() + (string)$request->getUri() ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } - + $result = $this->handleRangeCodeResponse( $response, '4XX', @@ -1280,18 +1237,17 @@ public function unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $ if ($result) { return $result; } - - switch($statusCode) { + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ('\Dropbox\Sign\Model\UnclaimedDraftCreateResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1308,20 +1264,19 @@ public function unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $ return [ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); - } catch (\JsonException $exception) { + } catch (JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', @@ -1338,11 +1293,9 @@ public function unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $ return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; - } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { throw $e; } @@ -1355,7 +1308,6 @@ public function unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $ ); $e->setResponseObject($data); break; - } throw $e; } @@ -1366,15 +1318,15 @@ public function unclaimedDraftEditAndResendWithHttpInfo($signature_request_id, $ * * Edit and Resend Unclaimed Draft * - * @param string $signature_request_id The ID of the signature request to edit and resend. (required) - * @param \Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation + * @param string $signature_request_id The ID of the signature request to edit and resend. (required) + * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftEditAndResend. This method will eventually become unavailable */ - public function unclaimedDraftEditAndResendAsync($signature_request_id, $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) + public function unclaimedDraftEditAndResendAsync(string $signature_request_id, Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) { return $this->unclaimedDraftEditAndResendAsyncWithHttpInfo($signature_request_id, $unclaimed_draft_edit_and_resend_request, $contentType) ->then( @@ -1389,15 +1341,15 @@ function ($response) { * * Edit and Resend Unclaimed Draft * - * @param string $signature_request_id The ID of the signature request to edit and resend. (required) - * @param \Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation + * @param string $signature_request_id The ID of the signature request to edit and resend. (required) + * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation * - * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftEditAndResend. This method will eventually become unavailable */ - public function unclaimedDraftEditAndResendAsyncWithHttpInfo($signature_request_id, $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) + public function unclaimedDraftEditAndResendAsyncWithHttpInfo(string $signature_request_id, Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) { $returnType = '\Dropbox\Sign\Model\UnclaimedDraftCreateResponse'; $request = $this->unclaimedDraftEditAndResendRequest($signature_request_id, $unclaimed_draft_edit_and_resend_request, $contentType); @@ -1407,9 +1359,9 @@ public function unclaimedDraftEditAndResendAsyncWithHttpInfo($signature_request_ ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } @@ -1418,7 +1370,7 @@ function ($response) use ($returnType) { return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; }, function ($exception) { @@ -1432,7 +1384,7 @@ function ($exception) { ), $statusCode, $response->getHeaders(), - (string) $response->getBody() + (string)$response->getBody() ); } ); @@ -1441,32 +1393,30 @@ function ($exception) { /** * Create request for operation 'unclaimedDraftEditAndResend' * - * @param string $signature_request_id The ID of the signature request to edit and resend. (required) - * @param \Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation + * @param string $signature_request_id The ID of the signature request to edit and resend. (required) + * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation * - * @throws \InvalidArgumentException - * @return \GuzzleHttp\Psr7\Request + * @return Request + * @throws InvalidArgumentException * @deprecated Prefer to use ::unclaimedDraftEditAndResend. This method will eventually become unavailable */ - public function unclaimedDraftEditAndResendRequest($signature_request_id, $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) + public function unclaimedDraftEditAndResendRequest(string $signature_request_id, Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request, string $contentType = self::contentTypes['unclaimedDraftEditAndResend'][0]) { - // verify the required parameter 'signature_request_id' is set if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $signature_request_id when calling unclaimedDraftEditAndResend' ); } // verify the required parameter 'unclaimed_draft_edit_and_resend_request' is set if ($unclaimed_draft_edit_and_resend_request === null || (is_array($unclaimed_draft_edit_and_resend_request) && count($unclaimed_draft_edit_and_resend_request) === 0)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( 'Missing the required parameter $unclaimed_draft_edit_and_resend_request when calling unclaimedDraftEditAndResend' ); } - $resourcePath = '/unclaimed_draft/edit_and_resend/{signature_request_id}'; $formParams = []; $queryParams = []; @@ -1480,19 +1430,17 @@ public function unclaimedDraftEditAndResendRequest($signature_request_id, $uncla $multipart = !empty($formParams); - // path params if ($signature_request_id !== null) { $resourcePath = str_replace( - '{' . 'signature_request_id' . '}', + '{signature_request_id}', ObjectSerializer::toPathValue($signature_request_id), $resourcePath ); } - $headers = $this->headerSelector->selectHeaders( - $multipart ? ['multipart/form-data'] : ['application/json', ], + $multipart ? ['multipart/form-data'] : ['application/json'], $contentType, $multipart ); @@ -1500,7 +1448,7 @@ public function unclaimedDraftEditAndResendRequest($signature_request_id, $uncla // for model (json/xml) if (count($formParams) === 0) { if (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the body + // if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($unclaimed_draft_edit_and_resend_request)); } else { $httpBody = $unclaimed_draft_edit_and_resend_request; @@ -1513,7 +1461,7 @@ public function unclaimedDraftEditAndResendRequest($signature_request_id, $uncla foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, - 'contents' => $formParamValueItem + 'contents' => $formParamValueItem, ]; } } @@ -1530,9 +1478,8 @@ public function unclaimedDraftEditAndResendRequest($signature_request_id, $uncla $payloadHook('multipart', $multipartContents, $unclaimed_draft_edit_and_resend_request); } $httpBody = new MultipartStream($multipartContents); - } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { - # if Content-Type contains "application/json", json_encode the form parameters + // if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) @@ -1573,8 +1520,8 @@ public function unclaimedDraftEditAndResendRequest($signature_request_id, $uncla /** * Create http client option * - * @throws \RuntimeException on file opening failure * @return array of http client options + * @throws RuntimeException on file opening failure */ protected function createHttpClientOption() { @@ -1582,7 +1529,7 @@ protected function createHttpClientOption() if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { - throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } @@ -1598,8 +1545,8 @@ private function handleRangeCodeResponse( string $returnDataType ) { $statusCode = $response->getStatusCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft @@ -1609,9 +1556,9 @@ private function handleRangeCodeResponse( } if ($returnDataType === '\SplFileObject') { - $content = $response->getBody(); //stream goes to serializer + $content = $response->getBody(); // stream goes to serializer } else { - $content = (string) $response->getBody(); + $content = (string)$response->getBody(); } return [ @@ -1630,8 +1577,8 @@ private function handleRangeCodeException( string $exceptionDataType ): bool { $statusCode = $e->getCode(); - $rangeCodeLeft = (int) (substr($rangeCode, 0, 1) . '00'); - $rangeCodeRight = (int) (substr($rangeCode, 0, 1) . '99'); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); if ( $statusCode < $rangeCodeLeft diff --git a/sdks/php/src/ApiException.php b/sdks/php/src/ApiException.php index df2c4cc9e..3d4a49ca7 100644 --- a/sdks/php/src/ApiException.php +++ b/sdks/php/src/ApiException.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,22 +26,21 @@ namespace Dropbox\Sign; -use \Exception; +use Exception; +use stdClass; /** * ApiException Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class ApiException extends Exception { /** * The HTTP body of the server response either as Json or string. * - * @var \stdClass|string|null + * @var stdClass|string|null */ protected $responseBody; @@ -64,12 +61,12 @@ class ApiException extends Exception /** * Constructor * - * @param string $message Error message - * @param int $code HTTP status code - * @param string[][]|null $responseHeaders HTTP response header - * @param \stdClass|string|null $responseBody HTTP decoded body of the server response either as \stdClass or string + * @param string $message Error message + * @param int $code HTTP status code + * @param string[][]|null $responseHeaders HTTP response header + * @param stdClass|string|null $responseBody HTTP decoded body of the server response either as \stdClass or string */ - public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null) + public function __construct(string $message = '', int $code = 0, ?array $responseHeaders = [], $responseBody = null) { parent::__construct($message, $code); $this->responseHeaders = $responseHeaders; @@ -89,7 +86,7 @@ public function getResponseHeaders() /** * Gets the HTTP body of the server response either as Json or string * - * @return \stdClass|string|null HTTP body of the server response either as \stdClass or string + * @return stdClass|string|null HTTP body of the server response either as \stdClass or string */ public function getResponseBody() { @@ -100,8 +97,6 @@ public function getResponseBody() * Sets the deserialized response object (during deserialization) * * @param string|int|object|array|mixed $obj Deserialized response object - * - * @return void */ public function setResponseObject($obj) { diff --git a/sdks/php/src/Configuration.php b/sdks/php/src/Configuration.php index 571f1482e..204b66994 100644 --- a/sdks/php/src/Configuration.php +++ b/sdks/php/src/Configuration.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,23 +26,21 @@ namespace Dropbox\Sign; +use InvalidArgumentException; + /** * Configuration Class Doc Comment * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class Configuration { public const BOOLEAN_FORMAT_INT = 'int'; public const BOOLEAN_FORMAT_STRING = 'string'; - /** - * @var Configuration - */ + /** @var Configuration */ private static $defaultConfiguration; /** @@ -132,7 +128,7 @@ class Configuration protected $options = []; /** @var ?callable */ - protected $payloadHook = null; + protected $payloadHook; /** * Constructor @@ -150,7 +146,7 @@ public function __construct() * * @return $this */ - protected function setApiKey($apiKeyIdentifier, $key) + protected function setApiKey(string $apiKeyIdentifier, string $key) { $this->apiKeys[$apiKeyIdentifier] = $key; return $this; @@ -161,9 +157,9 @@ protected function setApiKey($apiKeyIdentifier, $key) * * @param string $apiKeyIdentifier API key identifier (authentication scheme) * - * @return null|string API key or token + * @return string|null API key or token */ - protected function getApiKey($apiKeyIdentifier) + protected function getApiKey(string $apiKeyIdentifier) { return isset($this->apiKeys[$apiKeyIdentifier]) ? $this->apiKeys[$apiKeyIdentifier] : null; } @@ -176,7 +172,7 @@ protected function getApiKey($apiKeyIdentifier) * * @return $this */ - protected function setApiKeyPrefix($apiKeyIdentifier, $prefix) + protected function setApiKeyPrefix(string $apiKeyIdentifier, string $prefix) { $this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix; return $this; @@ -187,9 +183,9 @@ protected function setApiKeyPrefix($apiKeyIdentifier, $prefix) * * @param string $apiKeyIdentifier API key identifier (authentication scheme) * - * @return null|string + * @return string|null */ - protected function getApiKeyPrefix($apiKeyIdentifier) + protected function getApiKeyPrefix(string $apiKeyIdentifier) { return isset($this->apiKeyPrefixes[$apiKeyIdentifier]) ? $this->apiKeyPrefixes[$apiKeyIdentifier] : null; } @@ -201,7 +197,7 @@ protected function getApiKeyPrefix($apiKeyIdentifier) * * @return $this */ - public function setAccessToken($accessToken) + public function setAccessToken(string $accessToken) { $this->accessToken = $accessToken; return $this; @@ -248,7 +244,7 @@ public function getBooleanFormatForQueryString(): string * * @return $this */ - public function setUsername($username) + public function setUsername(string $username) { $this->username = $username; return $this; @@ -271,7 +267,7 @@ public function getUsername() * * @return $this */ - protected function setPassword($password) + protected function setPassword(string $password) { $this->password = $password; return $this; @@ -294,7 +290,7 @@ protected function getPassword() * * @return $this */ - public function setHost($host) + public function setHost(string $host) { $this->host = $host; return $this; @@ -315,13 +311,13 @@ public function getHost() * * @param string $userAgent the user agent of the api client * - * @throws \InvalidArgumentException * @return $this + * @throws InvalidArgumentException */ - public function setUserAgent($userAgent) + public function setUserAgent(string $userAgent) { if (!is_string($userAgent)) { - throw new \InvalidArgumentException('User-agent must be a string.'); + throw new InvalidArgumentException('User-agent must be a string.'); } $this->userAgent = $userAgent; @@ -345,7 +341,7 @@ public function getUserAgent() * * @return $this */ - public function setDebug($debug) + public function setDebug(bool $debug) { $this->debug = $debug; return $this; @@ -368,7 +364,7 @@ public function getDebug() * * @return $this */ - public function setDebugFile($debugFile) + public function setDebugFile(string $debugFile) { $this->debugFile = $debugFile; return $this; @@ -391,7 +387,7 @@ public function getDebugFile() * * @return $this */ - public function setTempFolderPath($tempFolderPath) + public function setTempFolderPath(string $tempFolderPath) { $this->tempFolderPath = $tempFolderPath; return $this; @@ -425,8 +421,6 @@ public static function getDefaultConfiguration() * Sets the default configuration instance * * @param Configuration $config An instance of the Configuration Object - * - * @return void */ public static function setDefaultConfiguration(Configuration $config) { @@ -440,7 +434,7 @@ public static function setDefaultConfiguration(Configuration $config) */ public static function toDebugReport() { - $report = 'PHP SDK (Dropbox\Sign) Debug Report:' . PHP_EOL; + $report = 'PHP SDK (Dropbox\Sign) Debug Report:' . PHP_EOL; $report .= ' OS: ' . php_uname() . PHP_EOL; $report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL; $report .= ' The version of the OpenAPI document: 3.0.0' . PHP_EOL; @@ -453,11 +447,11 @@ public static function toDebugReport() /** * Get API key (with prefix if set) * - * @param string $apiKeyIdentifier name of apikey + * @param string $apiKeyIdentifier name of apikey * - * @return null|string API key with the prefix + * @return string|null API key with the prefix */ - protected function getApiKeyWithPrefix($apiKeyIdentifier) + protected function getApiKeyWithPrefix(string $apiKeyIdentifier) { $prefix = $this->getApiKeyPrefix($apiKeyIdentifier); $apiKey = $this->getApiKey($apiKeyIdentifier); @@ -484,21 +478,21 @@ public function getHostSettings() { return [ [ - "url" => "https://api.hellosign.com/v3", - "description" => "No description provided", - ] + 'url' => 'https://api.hellosign.com/v3', + 'description' => 'No description provided', + ], ]; } /** - * Returns URL based on host settings, index and variables - * - * @param array $hostSettings array of host settings, generated from getHostSettings() or equivalent from the API clients - * @param int $hostIndex index of the host settings - * @param array|null $variables hash of variable and the corresponding value (optional) - * @return string URL based on host settings - */ - public static function getHostString(array $hostSettings, $hostIndex, array $variables = null) + * Returns URL based on host settings, index and variables + * + * @param array $hostSettings array of host settings, generated from getHostSettings() or equivalent from the API clients + * @param int $hostIndex index of the host settings + * @param array|null $variables hash of variable and the corresponding value (optional) + * @return string URL based on host settings + */ + public static function getHostString(array $hostSettings, int $hostIndex, array $variables = null) { if (null === $variables) { $variables = []; @@ -506,23 +500,23 @@ public static function getHostString(array $hostSettings, $hostIndex, array $var // check array index out of bound if ($hostIndex < 0 || $hostIndex >= count($hostSettings)) { - throw new \InvalidArgumentException("Invalid index $hostIndex when selecting the host. Must be less than ".count($hostSettings)); + throw new InvalidArgumentException("Invalid index {$hostIndex} when selecting the host. Must be less than " . count($hostSettings)); } $host = $hostSettings[$hostIndex]; - $url = $host["url"]; + $url = $host['url']; // go through variable and assign a value - foreach ($host["variables"] ?? [] as $name => $variable) { + foreach ($host['variables'] ?? [] as $name => $variable) { if (array_key_exists($name, $variables)) { // check to see if it's in the variables provided by the user - if (!isset($variable['enum_values']) || in_array($variables[$name], $variable["enum_values"], true)) { // check to see if the value is in the enum - $url = str_replace("{".$name."}", $variables[$name], $url); + if (!isset($variable['enum_values']) || in_array($variables[$name], $variable['enum_values'], true)) { // check to see if the value is in the enum + $url = str_replace('{' . $name . '}', $variables[$name], $url); } else { - throw new \InvalidArgumentException("The variable `$name` in the host URL has invalid value ".$variables[$name].". Must be ".join(',', $variable["enum_values"])."."); + throw new InvalidArgumentException("The variable `{$name}` in the host URL has invalid value " . $variables[$name] . '. Must be ' . join(',', $variable['enum_values']) . '.'); } } else { // use default value - $url = str_replace("{".$name."}", $variable["default_value"], $url); + $url = str_replace('{' . $name . '}', $variable['default_value'], $url); } } @@ -532,11 +526,11 @@ public static function getHostString(array $hostSettings, $hostIndex, array $var /** * Returns URL based on the index and variables * - * @param int $index index of the host settings - * @param array|null $variables hash of variable and the corresponding value (optional) - * @return string URL based on host settings + * @param int $index index of the host settings + * @param array|null $variables hash of variable and the corresponding value (optional) + * @return string URL based on host settings */ - public function getHostFromSettings($index, $variables = null) + public function getHostFromSettings(int $index, ?array $variables = null) { return self::getHostString($this->getHostSettings(), $index, $variables); } @@ -550,8 +544,6 @@ public function setOptions(array $options): self /** * Get extra request options - * - * @return array */ public function getOptions(): array { diff --git a/sdks/php/src/EventCallbackHelper.php b/sdks/php/src/EventCallbackHelper.php index 81b5960a5..16e76ec8b 100644 --- a/sdks/php/src/EventCallbackHelper.php +++ b/sdks/php/src/EventCallbackHelper.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -33,9 +31,7 @@ * EventCallbackHelper Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ abstract class EventCallbackHelper { diff --git a/sdks/php/src/HeaderSelector.php b/sdks/php/src/HeaderSelector.php index 98a8891b6..fe1faf2c1 100644 --- a/sdks/php/src/HeaderSelector.php +++ b/sdks/php/src/HeaderSelector.php @@ -4,9 +4,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -32,16 +30,12 @@ * HeaderSelector Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class HeaderSelector { /** - * @param string[] $accept - * @param string $contentType - * @param bool $isMultipart + * @param string[] $accept * @return string[] */ public function selectHeaders(array $accept, string $contentType, bool $isMultipart): array @@ -54,7 +48,7 @@ public function selectHeaders(array $accept, string $contentType, bool $isMultip } if (!$isMultipart) { - if($contentType === '') { + if ($contentType === '') { $contentType = 'application/json'; } @@ -69,41 +63,41 @@ public function selectHeaders(array $accept, string $contentType, bool $isMultip * * @param string[] $accept Array of header * - * @return null|string Accept (e.g. application/json) + * @return string|null Accept (e.g. application/json) */ private function selectAcceptHeader(array $accept): ?string { - # filter out empty entries + // filter out empty entries $accept = array_filter($accept); if (count($accept) === 0) { return null; } - # If there's only one Accept header, just use it + // If there's only one Accept header, just use it if (count($accept) === 1) { return reset($accept); } - # If none of the available Accept headers is of type "json", then just use all them + // If none of the available Accept headers is of type "json", then just use all them $headersWithJson = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept); if (count($headersWithJson) === 0) { return implode(',', $accept); } - # If we got here, then we need add quality values (weight), as described in IETF RFC 9110, Items 12.4.2/12.5.1, - # to give the highest priority to json-like headers - recalculating the existing ones, if needed + // If we got here, then we need add quality values (weight), as described in IETF RFC 9110, Items 12.4.2/12.5.1, + // to give the highest priority to json-like headers - recalculating the existing ones, if needed return $this->getAcceptHeaderWithAdjustedWeight($accept, $headersWithJson); } /** - * Create an Accept header string from the given "Accept" headers array, recalculating all weights - * - * @param string[] $accept Array of Accept Headers - * @param string[] $headersWithJson Array of Accept Headers of type "json" - * - * @return string "Accept" Header (e.g. "application/json, text/html; q=0.9") - */ + * Create an Accept header string from the given "Accept" headers array, recalculating all weights + * + * @param string[] $accept Array of Accept Headers + * @param string[] $headersWithJson Array of Accept Headers of type "json" + * + * @return string "Accept" Header (e.g. "application/json, text/html; q=0.9") + */ private function getAcceptHeaderWithAdjustedWeight(array $accept, array $headersWithJson): string { $processedHeaders = [ @@ -113,7 +107,6 @@ private function getAcceptHeaderWithAdjustedWeight(array $accept, array $headers ]; foreach ($accept as $header) { - $headerData = $this->getHeaderAndWeight($header); if (stripos($headerData['header'], 'application/json') === 0) { @@ -130,7 +123,7 @@ private function getAcceptHeaderWithAdjustedWeight(array $accept, array $headers $hasMoreThan28Headers = count($accept) > 28; - foreach($processedHeaders as $headers) { + foreach ($processedHeaders as $headers) { if (count($headers) > 0) { $acceptHeaders[] = $this->adjustWeight($headers, $currentWeight, $hasMoreThan28Headers); } @@ -150,7 +143,7 @@ private function getAcceptHeaderWithAdjustedWeight(array $accept, array $headers */ private function getHeaderAndWeight(string $header): array { - # matches headers with weight, splitting the header and the weight in $outputArray + // matches headers with weight, splitting the header and the weight in $outputArray if (preg_match('/(.*);\s*q=(1(?:\.0+)?|0\.\d+)$/', $header, $outputArray) === 1) { $headerData = [ 'header' => $outputArray[1], @@ -167,9 +160,7 @@ private function getHeaderAndWeight(string $header): array } /** - * @param array[] $headers - * @param float $currentWeight - * @param bool $hasMoreThan28Headers + * @param array[] $headers * @return string[] array of adjusted "Accept" headers */ private function adjustWeight(array $headers, float &$currentWeight, bool $hasMoreThan28Headers): array @@ -180,8 +171,7 @@ private function adjustWeight(array $headers, float &$currentWeight, bool $hasMo $acceptHeaders = []; foreach ($headers as $index => $header) { - if($index > 0 && $headers[$index - 1]['weight'] > $header['weight']) - { + if ($index > 0 && $headers[$index - 1]['weight'] > $header['weight']) { $currentWeight = $this->getNextWeight($currentWeight, $hasMoreThan28Headers); } @@ -195,14 +185,9 @@ private function adjustWeight(array $headers, float &$currentWeight, bool $hasMo return $acceptHeaders; } - /** - * @param string $header - * @param int $weight - * @return string - */ private function buildAcceptHeader(string $header, int $weight): string { - if($weight === 1000) { + if ($weight === 1000) { return $header; } @@ -227,9 +212,7 @@ private function buildAcceptHeader(string $header, int $weight): string * if there is a maximum of 28 "Accept" headers. If we have more than that (which is extremely unlikely), then we fall back to a 1-by-1 * decrement rule, which will result in quality codes like "q=0.999", "q=0.998" etc. * - * @param int $currentWeight varying from 1 to 1000 (will be divided by 1000 to build the quality value) - * @param bool $hasMoreThan28Headers - * @return int + * @param int $currentWeight varying from 1 to 1000 (will be divided by 1000 to build the quality value) */ public function getNextWeight(int $currentWeight, bool $hasMoreThan28Headers): int { @@ -241,6 +224,6 @@ public function getNextWeight(int $currentWeight, bool $hasMoreThan28Headers): i return $currentWeight - 1; } - return $currentWeight - 10 ** floor( log10($currentWeight - 1) ); + return $currentWeight - 10 ** floor(log10($currentWeight - 1)); } } diff --git a/sdks/php/src/Model/AccountCreateRequest.php b/sdks/php/src/Model/AccountCreateRequest.php index 443c56c08..f4b927310 100644 --- a/sdks/php/src/Model/AccountCreateRequest.php +++ b/sdks/php/src/Model/AccountCreateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * AccountCreateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class AccountCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'email_address' => 'string', 'client_id' => 'string', 'client_secret' => 'string', - 'locale' => 'string' + 'locale' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'email_address' => 'email', 'client_id' => null, 'client_secret' => null, - 'locale' => null + 'locale' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'email_address' => false, 'client_id' => false, 'client_secret' => false, - 'locale' => false + 'locale' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'email_address', 'client_id' => 'client_id', 'client_secret' => 'client_secret', - 'locale' => 'locale' + 'locale' => 'locale', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'setEmailAddress', 'client_id' => 'setClientId', 'client_secret' => 'setClientSecret', - 'locale' => 'setLocale' + 'locale' => 'setLocale', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'getEmailAddress', 'client_id' => 'getClientId', 'client_secret' => 'getClientSecret', - 'locale' => 'getLocale' + 'locale' => 'getLocale', ]; /** @@ -247,7 +238,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -269,34 +259,33 @@ public function __construct(array $data = null) $this->setIfExists('locale', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): AccountCreateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): AccountCreateRequest { /** @var AccountCreateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, AccountCreateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -332,7 +321,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets email_address * @@ -346,14 +334,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address The email address which will be associated with the new Account. + * @param string $email_address the email address which will be associated with the new Account * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -377,10 +365,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(?string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -404,10 +392,10 @@ public function getClientSecret() * * @return self */ - public function setClientSecret($client_secret) + public function setClientSecret(?string $client_secret) { if (is_null($client_secret)) { - throw new \InvalidArgumentException('non-nullable client_secret cannot be null'); + throw new InvalidArgumentException('non-nullable client_secret cannot be null'); } $this->container['client_secret'] = $client_secret; @@ -431,23 +419,22 @@ public function getLocale() * * @return self */ - public function setLocale($locale) + public function setLocale(?string $locale) { if (is_null($locale)) { - throw new \InvalidArgumentException('non-nullable locale cannot be null'); + throw new InvalidArgumentException('non-nullable locale cannot be null'); } $this->container['locale'] = $locale; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -456,11 +443,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -471,10 +458,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -487,11 +472,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -499,15 +482,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -533,5 +516,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/AccountCreateResponse.php b/sdks/php/src/Model/AccountCreateResponse.php index 62cbb213f..66e9a34d4 100644 --- a/sdks/php/src/Model/AccountCreateResponse.php +++ b/sdks/php/src/Model/AccountCreateResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * AccountCreateResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountCreateResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class AccountCreateResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountCreateResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account' => '\Dropbox\Sign\Model\AccountResponse', 'oauth_data' => '\Dropbox\Sign\Model\OAuthTokenResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account' => null, 'oauth_data' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account' => false, 'oauth_data' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'account' => 'account', 'oauth_data' => 'oauth_data', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'account' => 'setAccount', 'oauth_data' => 'setOauthData', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'account' => 'getAccount', 'oauth_data' => 'getOauthData', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): AccountCreateResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): AccountCreateResponse { /** @var AccountCreateResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, AccountCreateResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -325,11 +314,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account * - * @return \Dropbox\Sign\Model\AccountResponse + * @return AccountResponse */ public function getAccount() { @@ -339,14 +327,14 @@ public function getAccount() /** * Sets account * - * @param \Dropbox\Sign\Model\AccountResponse $account account + * @param AccountResponse $account account * * @return self */ - public function setAccount($account) + public function setAccount(AccountResponse $account) { if (is_null($account)) { - throw new \InvalidArgumentException('non-nullable account cannot be null'); + throw new InvalidArgumentException('non-nullable account cannot be null'); } $this->container['account'] = $account; @@ -356,7 +344,7 @@ public function setAccount($account) /** * Gets oauth_data * - * @return \Dropbox\Sign\Model\OAuthTokenResponse|null + * @return OAuthTokenResponse|null */ public function getOauthData() { @@ -366,14 +354,14 @@ public function getOauthData() /** * Sets oauth_data * - * @param \Dropbox\Sign\Model\OAuthTokenResponse|null $oauth_data oauth_data + * @param OAuthTokenResponse|null $oauth_data oauth_data * * @return self */ - public function setOauthData($oauth_data) + public function setOauthData(?OAuthTokenResponse $oauth_data) { if (is_null($oauth_data)) { - throw new \InvalidArgumentException('non-nullable oauth_data cannot be null'); + throw new InvalidArgumentException('non-nullable oauth_data cannot be null'); } $this->container['oauth_data'] = $oauth_data; @@ -383,7 +371,7 @@ public function setOauthData($oauth_data) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -393,27 +381,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -422,11 +409,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -437,10 +424,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -453,11 +438,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -465,15 +448,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -499,5 +482,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/AccountGetResponse.php b/sdks/php/src/Model/AccountGetResponse.php index 625f9b67a..b59da1285 100644 --- a/sdks/php/src/Model/AccountGetResponse.php +++ b/sdks/php/src/Model/AccountGetResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * AccountGetResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class AccountGetResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account' => '\Dropbox\Sign\Model\AccountResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account' => 'account', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account' => 'setAccount', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account' => 'getAccount', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): AccountGetResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): AccountGetResponse { /** @var AccountGetResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, AccountGetResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account * - * @return \Dropbox\Sign\Model\AccountResponse + * @return AccountResponse */ public function getAccount() { @@ -332,14 +320,14 @@ public function getAccount() /** * Sets account * - * @param \Dropbox\Sign\Model\AccountResponse $account account + * @param AccountResponse $account account * * @return self */ - public function setAccount($account) + public function setAccount(AccountResponse $account) { if (is_null($account)) { - throw new \InvalidArgumentException('non-nullable account cannot be null'); + throw new InvalidArgumentException('non-nullable account cannot be null'); } $this->container['account'] = $account; @@ -349,7 +337,7 @@ public function setAccount($account) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/AccountResponse.php b/sdks/php/src/Model/AccountResponse.php index 3f0e35060..3fb1a1869 100644 --- a/sdks/php/src/Model/AccountResponse.php +++ b/sdks/php/src/Model/AccountResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,35 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * AccountResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', @@ -68,16 +67,16 @@ class AccountResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'role_code' => 'string', 'team_id' => 'string', 'locale' => 'string', - 'usage' => '\Dropbox\Sign\Model\AccountResponseUsage' + 'usage' => '\Dropbox\Sign\Model\AccountResponseUsage', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => null, @@ -89,14 +88,14 @@ class AccountResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'role_code' => null, 'team_id' => null, 'locale' => null, - 'usage' => null + 'usage' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, @@ -108,14 +107,14 @@ class AccountResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'role_code' => true, 'team_id' => true, 'locale' => true, - 'usage' => false + 'usage' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -140,8 +139,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -151,7 +148,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -161,7 +158,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -170,9 +167,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -181,9 +175,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -207,7 +198,7 @@ public function isNullableSetToNull(string $property): bool 'role_code' => 'role_code', 'team_id' => 'team_id', 'locale' => 'locale', - 'usage' => 'usage' + 'usage' => 'usage', ]; /** @@ -226,7 +217,7 @@ public function isNullableSetToNull(string $property): bool 'role_code' => 'setRoleCode', 'team_id' => 'setTeamId', 'locale' => 'setLocale', - 'usage' => 'setUsage' + 'usage' => 'setUsage', ]; /** @@ -245,7 +236,7 @@ public function isNullableSetToNull(string $property): bool 'role_code' => 'getRoleCode', 'team_id' => 'getTeamId', 'locale' => 'getLocale', - 'usage' => 'getUsage' + 'usage' => 'getUsage', ]; /** @@ -289,7 +280,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -318,34 +308,33 @@ public function __construct(array $data = null) $this->setIfExists('usage', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): AccountResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): AccountResponse { /** @var AccountResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, AccountResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -362,9 +351,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -378,7 +365,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account_id * @@ -396,10 +382,10 @@ public function getAccountId() * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -419,14 +405,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address The email address associated with the Account. + * @param string|null $email_address the email address associated with the Account * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -446,14 +432,14 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool|null $is_locked Returns `true` if the user has been locked out of their account by a team admin. + * @param bool|null $is_locked returns `true` if the user has been locked out of their account by a team admin * * @return self */ - public function setIsLocked($is_locked) + public function setIsLocked(?bool $is_locked) { if (is_null($is_locked)) { - throw new \InvalidArgumentException('non-nullable is_locked cannot be null'); + throw new InvalidArgumentException('non-nullable is_locked cannot be null'); } $this->container['is_locked'] = $is_locked; @@ -473,14 +459,14 @@ public function getIsPaidHs() /** * Sets is_paid_hs * - * @param bool|null $is_paid_hs Returns `true` if the user has a paid Dropbox Sign account. + * @param bool|null $is_paid_hs returns `true` if the user has a paid Dropbox Sign account * * @return self */ - public function setIsPaidHs($is_paid_hs) + public function setIsPaidHs(?bool $is_paid_hs) { if (is_null($is_paid_hs)) { - throw new \InvalidArgumentException('non-nullable is_paid_hs cannot be null'); + throw new InvalidArgumentException('non-nullable is_paid_hs cannot be null'); } $this->container['is_paid_hs'] = $is_paid_hs; @@ -500,14 +486,14 @@ public function getIsPaidHf() /** * Sets is_paid_hf * - * @param bool|null $is_paid_hf Returns `true` if the user has a paid HelloFax account. + * @param bool|null $is_paid_hf returns `true` if the user has a paid HelloFax account * * @return self */ - public function setIsPaidHf($is_paid_hf) + public function setIsPaidHf(?bool $is_paid_hf) { if (is_null($is_paid_hf)) { - throw new \InvalidArgumentException('non-nullable is_paid_hf cannot be null'); + throw new InvalidArgumentException('non-nullable is_paid_hf cannot be null'); } $this->container['is_paid_hf'] = $is_paid_hf; @@ -517,7 +503,7 @@ public function setIsPaidHf($is_paid_hf) /** * Gets quotas * - * @return \Dropbox\Sign\Model\AccountResponseQuotas|null + * @return AccountResponseQuotas|null */ public function getQuotas() { @@ -527,14 +513,14 @@ public function getQuotas() /** * Sets quotas * - * @param \Dropbox\Sign\Model\AccountResponseQuotas|null $quotas quotas + * @param AccountResponseQuotas|null $quotas quotas * * @return self */ - public function setQuotas($quotas) + public function setQuotas(?AccountResponseQuotas $quotas) { if (is_null($quotas)) { - throw new \InvalidArgumentException('non-nullable quotas cannot be null'); + throw new InvalidArgumentException('non-nullable quotas cannot be null'); } $this->container['quotas'] = $quotas; @@ -554,18 +540,18 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url The URL that Dropbox Sign events will `POST` to. + * @param string|null $callback_url the URL that Dropbox Sign events will `POST` to * * @return self */ - public function setCallbackUrl($callback_url) + public function setCallbackUrl(?string $callback_url) { if (is_null($callback_url)) { array_push($this->openAPINullablesSetToNull, 'callback_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('callback_url', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -588,18 +574,18 @@ public function getRoleCode() /** * Sets role_code * - * @param string|null $role_code The membership role for the team. + * @param string|null $role_code the membership role for the team * * @return self */ - public function setRoleCode($role_code) + public function setRoleCode(?string $role_code) { if (is_null($role_code)) { array_push($this->openAPINullablesSetToNull, 'role_code'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('role_code', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -622,18 +608,18 @@ public function getTeamId() /** * Sets team_id * - * @param string|null $team_id The id of the team account belongs to. + * @param string|null $team_id the id of the team account belongs to * * @return self */ - public function setTeamId($team_id) + public function setTeamId(?string $team_id) { if (is_null($team_id)) { array_push($this->openAPINullablesSetToNull, 'team_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('team_id', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -660,14 +646,14 @@ public function getLocale() * * @return self */ - public function setLocale($locale) + public function setLocale(?string $locale) { if (is_null($locale)) { array_push($this->openAPINullablesSetToNull, 'locale'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('locale', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -680,7 +666,7 @@ public function setLocale($locale) /** * Gets usage * - * @return \Dropbox\Sign\Model\AccountResponseUsage|null + * @return AccountResponseUsage|null */ public function getUsage() { @@ -690,27 +676,26 @@ public function getUsage() /** * Sets usage * - * @param \Dropbox\Sign\Model\AccountResponseUsage|null $usage usage + * @param AccountResponseUsage|null $usage usage * * @return self */ - public function setUsage($usage) + public function setUsage(?AccountResponseUsage $usage) { if (is_null($usage)) { - throw new \InvalidArgumentException('non-nullable usage cannot be null'); + throw new InvalidArgumentException('non-nullable usage cannot be null'); } $this->container['usage'] = $usage; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -719,11 +704,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -734,10 +719,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -750,11 +733,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -762,15 +743,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -796,5 +777,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/AccountResponseQuotas.php b/sdks/php/src/Model/AccountResponseQuotas.php index b4dff9e73..85d004055 100644 --- a/sdks/php/src/Model/AccountResponseQuotas.php +++ b/sdks/php/src/Model/AccountResponseQuotas.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,79 +27,79 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use JsonSerializable; +use ReturnTypeWillChange; /** * AccountResponseQuotas Class Doc Comment * * @category Class * @description Details concerning remaining monthly quotas. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountResponseQuotas implements ModelInterface, ArrayAccess, \JsonSerializable +class AccountResponseQuotas implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountResponseQuotas'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'api_signature_requests_left' => 'int', 'documents_left' => 'int', 'templates_total' => 'int', 'templates_left' => 'int', 'sms_verifications_left' => 'int', - 'num_fax_pages_left' => 'int' + 'num_fax_pages_left' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'api_signature_requests_left' => null, 'documents_left' => null, 'templates_total' => null, 'templates_left' => null, 'sms_verifications_left' => null, - 'num_fax_pages_left' => null + 'num_fax_pages_left' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'api_signature_requests_left' => true, 'documents_left' => true, 'templates_total' => true, 'templates_left' => true, 'sms_verifications_left' => true, - 'num_fax_pages_left' => true + 'num_fax_pages_left' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -126,8 +124,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -137,7 +133,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -147,7 +143,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -156,9 +152,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -167,9 +160,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -188,7 +178,7 @@ public function isNullableSetToNull(string $property): bool 'templates_total' => 'templates_total', 'templates_left' => 'templates_left', 'sms_verifications_left' => 'sms_verifications_left', - 'num_fax_pages_left' => 'num_fax_pages_left' + 'num_fax_pages_left' => 'num_fax_pages_left', ]; /** @@ -202,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'templates_total' => 'setTemplatesTotal', 'templates_left' => 'setTemplatesLeft', 'sms_verifications_left' => 'setSmsVerificationsLeft', - 'num_fax_pages_left' => 'setNumFaxPagesLeft' + 'num_fax_pages_left' => 'setNumFaxPagesLeft', ]; /** @@ -216,7 +206,7 @@ public function isNullableSetToNull(string $property): bool 'templates_total' => 'getTemplatesTotal', 'templates_left' => 'getTemplatesLeft', 'sms_verifications_left' => 'getSmsVerificationsLeft', - 'num_fax_pages_left' => 'getNumFaxPagesLeft' + 'num_fax_pages_left' => 'getNumFaxPagesLeft', ]; /** @@ -260,7 +250,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -284,34 +273,33 @@ public function __construct(array $data = null) $this->setIfExists('num_fax_pages_left', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): AccountResponseQuotas { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): AccountResponseQuotas { /** @var AccountResponseQuotas */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, AccountResponseQuotas::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,9 +316,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -344,7 +330,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets api_signature_requests_left * @@ -358,18 +343,18 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int|null $api_signature_requests_left API signature requests remaining. + * @param int|null $api_signature_requests_left API signature requests remaining * * @return self */ - public function setApiSignatureRequestsLeft($api_signature_requests_left) + public function setApiSignatureRequestsLeft(?int $api_signature_requests_left) { if (is_null($api_signature_requests_left)) { array_push($this->openAPINullablesSetToNull, 'api_signature_requests_left'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('api_signature_requests_left', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -392,18 +377,18 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int|null $documents_left Signature requests remaining. + * @param int|null $documents_left signature requests remaining * * @return self */ - public function setDocumentsLeft($documents_left) + public function setDocumentsLeft(?int $documents_left) { if (is_null($documents_left)) { array_push($this->openAPINullablesSetToNull, 'documents_left'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('documents_left', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -426,18 +411,18 @@ public function getTemplatesTotal() /** * Sets templates_total * - * @param int|null $templates_total Total API templates allowed. + * @param int|null $templates_total total API templates allowed * * @return self */ - public function setTemplatesTotal($templates_total) + public function setTemplatesTotal(?int $templates_total) { if (is_null($templates_total)) { array_push($this->openAPINullablesSetToNull, 'templates_total'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('templates_total', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -460,18 +445,18 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int|null $templates_left API templates remaining. + * @param int|null $templates_left API templates remaining * * @return self */ - public function setTemplatesLeft($templates_left) + public function setTemplatesLeft(?int $templates_left) { if (is_null($templates_left)) { array_push($this->openAPINullablesSetToNull, 'templates_left'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('templates_left', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -494,18 +479,18 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int|null $sms_verifications_left SMS verifications remaining. + * @param int|null $sms_verifications_left SMS verifications remaining * * @return self */ - public function setSmsVerificationsLeft($sms_verifications_left) + public function setSmsVerificationsLeft(?int $sms_verifications_left) { if (is_null($sms_verifications_left)) { array_push($this->openAPINullablesSetToNull, 'sms_verifications_left'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('sms_verifications_left', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -532,14 +517,14 @@ public function getNumFaxPagesLeft() * * @return self */ - public function setNumFaxPagesLeft($num_fax_pages_left) + public function setNumFaxPagesLeft(?int $num_fax_pages_left) { if (is_null($num_fax_pages_left)) { array_push($this->openAPINullablesSetToNull, 'num_fax_pages_left'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('num_fax_pages_left', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -548,14 +533,13 @@ public function setNumFaxPagesLeft($num_fax_pages_left) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -564,11 +548,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -579,10 +563,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -595,11 +577,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -607,15 +587,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -641,5 +621,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/AccountResponseUsage.php b/sdks/php/src/Model/AccountResponseUsage.php index 4f2d93556..94eb509e7 100644 --- a/sdks/php/src/Model/AccountResponseUsage.php +++ b/sdks/php/src/Model/AccountResponseUsage.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,64 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use JsonSerializable; +use ReturnTypeWillChange; /** * AccountResponseUsage Class Doc Comment * * @category Class * @description Details concerning monthly usage - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountResponseUsage implements ModelInterface, ArrayAccess, \JsonSerializable +class AccountResponseUsage implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountResponseUsage'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'fax_pages_sent' => 'int' + 'fax_pages_sent' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'fax_pages_sent' => null + 'fax_pages_sent' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'fax_pages_sent' => true + 'fax_pages_sent' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -168,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'fax_pages_sent' => 'fax_pages_sent' + 'fax_pages_sent' => 'fax_pages_sent', ]; /** @@ -177,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'fax_pages_sent' => 'setFaxPagesSent' + 'fax_pages_sent' => 'setFaxPagesSent', ]; /** @@ -186,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'fax_pages_sent' => 'getFaxPagesSent' + 'fax_pages_sent' => 'getFaxPagesSent', ]; /** @@ -230,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -249,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('fax_pages_sent', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): AccountResponseUsage { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): AccountResponseUsage { /** @var AccountResponseUsage */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, AccountResponseUsage::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -309,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets fax_pages_sent * @@ -327,14 +312,14 @@ public function getFaxPagesSent() * * @return self */ - public function setFaxPagesSent($fax_pages_sent) + public function setFaxPagesSent(?int $fax_pages_sent) { if (is_null($fax_pages_sent)) { array_push($this->openAPINullablesSetToNull, 'fax_pages_sent'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('fax_pages_sent', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -343,14 +328,13 @@ public function setFaxPagesSent($fax_pages_sent) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -359,11 +343,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -374,10 +358,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -390,11 +372,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -402,15 +382,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -436,5 +416,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/AccountUpdateRequest.php b/sdks/php/src/Model/AccountUpdateRequest.php index 7db624751..34a65c498 100644 --- a/sdks/php/src/Model/AccountUpdateRequest.php +++ b/sdks/php/src/Model/AccountUpdateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * AccountUpdateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class AccountUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountUpdateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'callback_url' => 'string', - 'locale' => 'string' + 'locale' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'callback_url' => null, - 'locale' => null + 'locale' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account_id' => true, 'callback_url' => false, - 'locale' => false + 'locale' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'account_id' => 'account_id', 'callback_url' => 'callback_url', - 'locale' => 'locale' + 'locale' => 'locale', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'account_id' => 'setAccountId', 'callback_url' => 'setCallbackUrl', - 'locale' => 'setLocale' + 'locale' => 'setLocale', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'account_id' => 'getAccountId', 'callback_url' => 'getCallbackUrl', - 'locale' => 'getLocale' + 'locale' => 'getLocale', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('locale', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): AccountUpdateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): AccountUpdateRequest { /** @var AccountUpdateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, AccountUpdateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,9 +295,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -322,7 +309,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account_id * @@ -340,14 +326,14 @@ public function getAccountId() * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { array_push($this->openAPINullablesSetToNull, 'account_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('account_id', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -370,14 +356,14 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url The URL that Dropbox Sign should POST events to. + * @param string|null $callback_url the URL that Dropbox Sign should POST events to * * @return self */ - public function setCallbackUrl($callback_url) + public function setCallbackUrl(?string $callback_url) { if (is_null($callback_url)) { - throw new \InvalidArgumentException('non-nullable callback_url cannot be null'); + throw new InvalidArgumentException('non-nullable callback_url cannot be null'); } $this->container['callback_url'] = $callback_url; @@ -401,23 +387,22 @@ public function getLocale() * * @return self */ - public function setLocale($locale) + public function setLocale(?string $locale) { if (is_null($locale)) { - throw new \InvalidArgumentException('non-nullable locale cannot be null'); + throw new InvalidArgumentException('non-nullable locale cannot be null'); } $this->container['locale'] = $locale; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -426,11 +411,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -441,10 +426,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -457,11 +440,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -469,15 +450,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -503,5 +484,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/AccountVerifyRequest.php b/sdks/php/src/Model/AccountVerifyRequest.php index 3ebd4ab79..d8731ea40 100644 --- a/sdks/php/src/Model/AccountVerifyRequest.php +++ b/sdks/php/src/Model/AccountVerifyRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * AccountVerifyRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountVerifyRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class AccountVerifyRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountVerifyRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'email_address' => 'string' + 'email_address' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'email_address' => 'email' + 'email_address' => 'email', ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'email_address' => false + 'email_address' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'email_address' => 'email_address' + 'email_address' => 'email_address', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'email_address' => 'setEmailAddress' + 'email_address' => 'setEmailAddress', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'email_address' => 'getEmailAddress' + 'email_address' => 'getEmailAddress', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): AccountVerifyRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): AccountVerifyRequest { /** @var AccountVerifyRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, AccountVerifyRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -311,7 +300,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets email_address * @@ -325,27 +313,26 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address Email address to run the verification for. + * @param string $email_address email address to run the verification for * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -354,11 +341,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -369,10 +356,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -385,11 +370,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -397,15 +380,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -431,5 +414,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/AccountVerifyResponse.php b/sdks/php/src/Model/AccountVerifyResponse.php index 9a3663463..f8f6a65e5 100644 --- a/sdks/php/src/Model/AccountVerifyResponse.php +++ b/sdks/php/src/Model/AccountVerifyResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * AccountVerifyResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountVerifyResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class AccountVerifyResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountVerifyResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account' => '\Dropbox\Sign\Model\AccountVerifyResponseAccount', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account' => 'account', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account' => 'setAccount', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account' => 'getAccount', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): AccountVerifyResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): AccountVerifyResponse { /** @var AccountVerifyResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, AccountVerifyResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -299,9 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -315,11 +302,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account * - * @return \Dropbox\Sign\Model\AccountVerifyResponseAccount|null + * @return AccountVerifyResponseAccount|null */ public function getAccount() { @@ -329,14 +315,14 @@ public function getAccount() /** * Sets account * - * @param \Dropbox\Sign\Model\AccountVerifyResponseAccount|null $account account + * @param AccountVerifyResponseAccount|null $account account * * @return self */ - public function setAccount($account) + public function setAccount(?AccountVerifyResponseAccount $account) { if (is_null($account)) { - throw new \InvalidArgumentException('non-nullable account cannot be null'); + throw new InvalidArgumentException('non-nullable account cannot be null'); } $this->container['account'] = $account; @@ -346,7 +332,7 @@ public function setAccount($account) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -356,27 +342,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -385,11 +370,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -400,10 +385,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -416,11 +399,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -428,15 +409,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -462,5 +443,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/AccountVerifyResponseAccount.php b/sdks/php/src/Model/AccountVerifyResponseAccount.php index 70749476b..34a1de5e9 100644 --- a/sdks/php/src/Model/AccountVerifyResponseAccount.php +++ b/sdks/php/src/Model/AccountVerifyResponseAccount.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * AccountVerifyResponseAccount Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class AccountVerifyResponseAccount implements ModelInterface, ArrayAccess, \JsonSerializable +class AccountVerifyResponseAccount implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'AccountVerifyResponseAccount'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'email_address' => 'string' + 'email_address' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'email_address' => null + 'email_address' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'email_address' => false + 'email_address' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'email_address' => 'email_address' + 'email_address' => 'email_address', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'email_address' => 'setEmailAddress' + 'email_address' => 'setEmailAddress', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'email_address' => 'getEmailAddress' + 'email_address' => 'getEmailAddress', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): AccountVerifyResponseAccount { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): AccountVerifyResponseAccount { /** @var AccountVerifyResponseAccount */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, AccountVerifyResponseAccount::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -292,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -308,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets email_address * @@ -322,27 +308,26 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address The email address associated with the Account. + * @param string|null $email_address the email address associated with the Account * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -351,11 +336,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -366,10 +351,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -382,11 +365,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -394,15 +375,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -428,5 +409,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ApiAppCreateRequest.php b/sdks/php/src/Model/ApiAppCreateRequest.php index 65521c6e8..d31444091 100644 --- a/sdks/php/src/Model/ApiAppCreateRequest.php +++ b/sdks/php/src/Model/ApiAppCreateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * ApiAppCreateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class ApiAppCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'domains' => 'string[]', 'name' => 'string', @@ -64,16 +64,16 @@ class ApiAppCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializa 'custom_logo_file' => '\SplFileObject', 'oauth' => '\Dropbox\Sign\Model\SubOAuth', 'options' => '\Dropbox\Sign\Model\SubOptions', - 'white_labeling_options' => '\Dropbox\Sign\Model\SubWhiteLabelingOptions' + 'white_labeling_options' => '\Dropbox\Sign\Model\SubWhiteLabelingOptions', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'domains' => null, 'name' => null, @@ -81,14 +81,14 @@ class ApiAppCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializa 'custom_logo_file' => 'binary', 'oauth' => null, 'options' => null, - 'white_labeling_options' => null + 'white_labeling_options' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'domains' => false, 'name' => false, @@ -96,14 +96,14 @@ class ApiAppCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializa 'custom_logo_file' => false, 'oauth' => false, 'options' => false, - 'white_labeling_options' => false + 'white_labeling_options' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -128,8 +128,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -139,7 +137,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -149,7 +147,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -158,9 +156,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -169,9 +164,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -191,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'custom_logo_file' => 'custom_logo_file', 'oauth' => 'oauth', 'options' => 'options', - 'white_labeling_options' => 'white_labeling_options' + 'white_labeling_options' => 'white_labeling_options', ]; /** @@ -206,7 +198,7 @@ public function isNullableSetToNull(string $property): bool 'custom_logo_file' => 'setCustomLogoFile', 'oauth' => 'setOauth', 'options' => 'setOptions', - 'white_labeling_options' => 'setWhiteLabelingOptions' + 'white_labeling_options' => 'setWhiteLabelingOptions', ]; /** @@ -221,7 +213,7 @@ public function isNullableSetToNull(string $property): bool 'custom_logo_file' => 'getCustomLogoFile', 'oauth' => 'getOauth', 'options' => 'getOptions', - 'white_labeling_options' => 'getWhiteLabelingOptions' + 'white_labeling_options' => 'getWhiteLabelingOptions', ]; /** @@ -265,7 +257,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -290,34 +281,33 @@ public function __construct(array $data = null) $this->setIfExists('white_labeling_options', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ApiAppCreateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ApiAppCreateRequest { /** @var ApiAppCreateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ApiAppCreateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -339,11 +329,11 @@ public function listInvalidProperties() if ($this->container['domains'] === null) { $invalidProperties[] = "'domains' can't be null"; } - if ((count($this->container['domains']) > 2)) { + if (count($this->container['domains']) > 2) { $invalidProperties[] = "invalid value for 'domains', number of items must be less than or equal to 2."; } - if ((count($this->container['domains']) < 1)) { + if (count($this->container['domains']) < 1) { $invalidProperties[] = "invalid value for 'domains', number of items must be greater than or equal to 1."; } @@ -364,7 +354,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets domains * @@ -378,21 +367,21 @@ public function getDomains() /** * Sets domains * - * @param string[] $domains The domain names the ApiApp will be associated with. + * @param string[] $domains the domain names the ApiApp will be associated with * * @return self */ - public function setDomains($domains) + public function setDomains(array $domains) { if (is_null($domains)) { - throw new \InvalidArgumentException('non-nullable domains cannot be null'); + throw new InvalidArgumentException('non-nullable domains cannot be null'); } - if ((count($domains) > 2)) { - throw new \InvalidArgumentException('invalid value for $domains when calling ApiAppCreateRequest., number of items must be less than or equal to 2.'); + if (count($domains) > 2) { + throw new InvalidArgumentException('invalid value for $domains when calling ApiAppCreateRequest., number of items must be less than or equal to 2.'); } - if ((count($domains) < 1)) { - throw new \InvalidArgumentException('invalid length for $domains when calling ApiAppCreateRequest., number of items must be greater than or equal to 1.'); + if (count($domains) < 1) { + throw new InvalidArgumentException('invalid length for $domains when calling ApiAppCreateRequest., number of items must be greater than or equal to 1.'); } $this->container['domains'] = $domains; @@ -412,14 +401,14 @@ public function getName() /** * Sets name * - * @param string $name The name you want to assign to the ApiApp. + * @param string $name the name you want to assign to the ApiApp * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -439,14 +428,14 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url The URL at which the ApiApp should receive event callbacks. + * @param string|null $callback_url the URL at which the ApiApp should receive event callbacks * * @return self */ - public function setCallbackUrl($callback_url) + public function setCallbackUrl(?string $callback_url) { if (is_null($callback_url)) { - throw new \InvalidArgumentException('non-nullable callback_url cannot be null'); + throw new InvalidArgumentException('non-nullable callback_url cannot be null'); } $this->container['callback_url'] = $callback_url; @@ -456,7 +445,7 @@ public function setCallbackUrl($callback_url) /** * Gets custom_logo_file * - * @return \SplFileObject|null + * @return SplFileObject|null */ public function getCustomLogoFile() { @@ -466,14 +455,14 @@ public function getCustomLogoFile() /** * Sets custom_logo_file * - * @param \SplFileObject|null $custom_logo_file An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) + * @param SplFileObject|null $custom_logo_file An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) * * @return self */ - public function setCustomLogoFile($custom_logo_file) + public function setCustomLogoFile(?SplFileObject $custom_logo_file) { if (is_null($custom_logo_file)) { - throw new \InvalidArgumentException('non-nullable custom_logo_file cannot be null'); + throw new InvalidArgumentException('non-nullable custom_logo_file cannot be null'); } $this->container['custom_logo_file'] = $custom_logo_file; @@ -483,7 +472,7 @@ public function setCustomLogoFile($custom_logo_file) /** * Gets oauth * - * @return \Dropbox\Sign\Model\SubOAuth|null + * @return SubOAuth|null */ public function getOauth() { @@ -493,14 +482,14 @@ public function getOauth() /** * Sets oauth * - * @param \Dropbox\Sign\Model\SubOAuth|null $oauth oauth + * @param SubOAuth|null $oauth oauth * * @return self */ - public function setOauth($oauth) + public function setOauth(?SubOAuth $oauth) { if (is_null($oauth)) { - throw new \InvalidArgumentException('non-nullable oauth cannot be null'); + throw new InvalidArgumentException('non-nullable oauth cannot be null'); } $this->container['oauth'] = $oauth; @@ -510,7 +499,7 @@ public function setOauth($oauth) /** * Gets options * - * @return \Dropbox\Sign\Model\SubOptions|null + * @return SubOptions|null */ public function getOptions() { @@ -520,14 +509,14 @@ public function getOptions() /** * Sets options * - * @param \Dropbox\Sign\Model\SubOptions|null $options options + * @param SubOptions|null $options options * * @return self */ - public function setOptions($options) + public function setOptions(?SubOptions $options) { if (is_null($options)) { - throw new \InvalidArgumentException('non-nullable options cannot be null'); + throw new InvalidArgumentException('non-nullable options cannot be null'); } $this->container['options'] = $options; @@ -537,7 +526,7 @@ public function setOptions($options) /** * Gets white_labeling_options * - * @return \Dropbox\Sign\Model\SubWhiteLabelingOptions|null + * @return SubWhiteLabelingOptions|null */ public function getWhiteLabelingOptions() { @@ -547,27 +536,26 @@ public function getWhiteLabelingOptions() /** * Sets white_labeling_options * - * @param \Dropbox\Sign\Model\SubWhiteLabelingOptions|null $white_labeling_options white_labeling_options + * @param SubWhiteLabelingOptions|null $white_labeling_options white_labeling_options * * @return self */ - public function setWhiteLabelingOptions($white_labeling_options) + public function setWhiteLabelingOptions(?SubWhiteLabelingOptions $white_labeling_options) { if (is_null($white_labeling_options)) { - throw new \InvalidArgumentException('non-nullable white_labeling_options cannot be null'); + throw new InvalidArgumentException('non-nullable white_labeling_options cannot be null'); } $this->container['white_labeling_options'] = $white_labeling_options; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -576,11 +564,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -591,10 +579,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -607,11 +593,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -619,15 +603,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -653,5 +637,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ApiAppGetResponse.php b/sdks/php/src/Model/ApiAppGetResponse.php index 35cda6354..f95c2b6e0 100644 --- a/sdks/php/src/Model/ApiAppGetResponse.php +++ b/sdks/php/src/Model/ApiAppGetResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ApiAppGetResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class ApiAppGetResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'api_app' => '\Dropbox\Sign\Model\ApiAppResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'api_app' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'api_app' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'api_app' => 'api_app', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'api_app' => 'setApiApp', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'api_app' => 'getApiApp', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ApiAppGetResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ApiAppGetResponse { /** @var ApiAppGetResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ApiAppGetResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets api_app * - * @return \Dropbox\Sign\Model\ApiAppResponse + * @return ApiAppResponse */ public function getApiApp() { @@ -332,14 +320,14 @@ public function getApiApp() /** * Sets api_app * - * @param \Dropbox\Sign\Model\ApiAppResponse $api_app api_app + * @param ApiAppResponse $api_app api_app * * @return self */ - public function setApiApp($api_app) + public function setApiApp(ApiAppResponse $api_app) { if (is_null($api_app)) { - throw new \InvalidArgumentException('non-nullable api_app cannot be null'); + throw new InvalidArgumentException('non-nullable api_app cannot be null'); } $this->container['api_app'] = $api_app; @@ -349,7 +337,7 @@ public function setApiApp($api_app) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ApiAppListResponse.php b/sdks/php/src/Model/ApiAppListResponse.php index bbc9dd238..44afca3c1 100644 --- a/sdks/php/src/Model/ApiAppListResponse.php +++ b/sdks/php/src/Model/ApiAppListResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ApiAppListResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppListResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class ApiAppListResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'api_apps' => '\Dropbox\Sign\Model\ApiAppResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'api_apps' => null, 'list_info' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'api_apps' => false, 'list_info' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'api_apps' => 'api_apps', 'list_info' => 'list_info', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'api_apps' => 'setApiApps', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'api_apps' => 'getApiApps', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ApiAppListResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ApiAppListResponse { /** @var ApiAppListResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ApiAppListResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,11 +317,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets api_apps * - * @return \Dropbox\Sign\Model\ApiAppResponse[] + * @return ApiAppResponse[] */ public function getApiApps() { @@ -342,14 +330,14 @@ public function getApiApps() /** * Sets api_apps * - * @param \Dropbox\Sign\Model\ApiAppResponse[] $api_apps Contains information about API Apps. + * @param ApiAppResponse[] $api_apps contains information about API Apps * * @return self */ - public function setApiApps($api_apps) + public function setApiApps(array $api_apps) { if (is_null($api_apps)) { - throw new \InvalidArgumentException('non-nullable api_apps cannot be null'); + throw new InvalidArgumentException('non-nullable api_apps cannot be null'); } $this->container['api_apps'] = $api_apps; @@ -359,7 +347,7 @@ public function setApiApps($api_apps) /** * Gets list_info * - * @return \Dropbox\Sign\Model\ListInfoResponse + * @return ListInfoResponse */ public function getListInfo() { @@ -369,14 +357,14 @@ public function getListInfo() /** * Sets list_info * - * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info + * @param ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo($list_info) + public function setListInfo(ListInfoResponse $list_info) { if (is_null($list_info)) { - throw new \InvalidArgumentException('non-nullable list_info cannot be null'); + throw new InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -386,7 +374,7 @@ public function setListInfo($list_info) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -396,27 +384,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -425,11 +412,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -440,10 +427,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -456,11 +441,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -468,15 +451,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -502,5 +485,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ApiAppResponse.php b/sdks/php/src/Model/ApiAppResponse.php index d62f18ec1..3e214031d 100644 --- a/sdks/php/src/Model/ApiAppResponse.php +++ b/sdks/php/src/Model/ApiAppResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ApiAppResponse Class Doc Comment * * @category Class * @description Contains information about an API App. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'callback_url' => 'string', 'client_id' => 'string', @@ -68,16 +67,16 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'oauth' => '\Dropbox\Sign\Model\ApiAppResponseOAuth', 'options' => '\Dropbox\Sign\Model\ApiAppResponseOptions', 'owner_account' => '\Dropbox\Sign\Model\ApiAppResponseOwnerAccount', - 'white_labeling_options' => '\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions' + 'white_labeling_options' => '\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'callback_url' => null, 'client_id' => null, @@ -88,14 +87,14 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'oauth' => null, 'options' => null, 'owner_account' => null, - 'white_labeling_options' => null + 'white_labeling_options' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'callback_url' => true, 'client_id' => false, @@ -106,14 +105,14 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'oauth' => true, 'options' => true, 'owner_account' => false, - 'white_labeling_options' => true + 'white_labeling_options' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -138,8 +137,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -149,7 +146,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -159,7 +156,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -168,9 +165,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -179,9 +173,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'oauth' => 'oauth', 'options' => 'options', 'owner_account' => 'owner_account', - 'white_labeling_options' => 'white_labeling_options' + 'white_labeling_options' => 'white_labeling_options', ]; /** @@ -222,7 +213,7 @@ public function isNullableSetToNull(string $property): bool 'oauth' => 'setOauth', 'options' => 'setOptions', 'owner_account' => 'setOwnerAccount', - 'white_labeling_options' => 'setWhiteLabelingOptions' + 'white_labeling_options' => 'setWhiteLabelingOptions', ]; /** @@ -240,7 +231,7 @@ public function isNullableSetToNull(string $property): bool 'oauth' => 'getOauth', 'options' => 'getOptions', 'owner_account' => 'getOwnerAccount', - 'white_labeling_options' => 'getWhiteLabelingOptions' + 'white_labeling_options' => 'getWhiteLabelingOptions', ]; /** @@ -284,7 +275,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -312,34 +302,33 @@ public function __construct(array $data = null) $this->setIfExists('white_labeling_options', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ApiAppResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ApiAppResponse { /** @var ApiAppResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ApiAppResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -356,9 +345,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -372,7 +359,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets callback_url * @@ -390,14 +376,14 @@ public function getCallbackUrl() * * @return self */ - public function setCallbackUrl($callback_url) + public function setCallbackUrl(?string $callback_url) { if (is_null($callback_url)) { array_push($this->openAPINullablesSetToNull, 'callback_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('callback_url', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -424,10 +410,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(?string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -451,10 +437,10 @@ public function getCreatedAt() * * @return self */ - public function setCreatedAt($created_at) + public function setCreatedAt(?int $created_at) { if (is_null($created_at)) { - throw new \InvalidArgumentException('non-nullable created_at cannot be null'); + throw new InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; @@ -478,10 +464,10 @@ public function getDomains() * * @return self */ - public function setDomains($domains) + public function setDomains(?array $domains) { if (is_null($domains)) { - throw new \InvalidArgumentException('non-nullable domains cannot be null'); + throw new InvalidArgumentException('non-nullable domains cannot be null'); } $this->container['domains'] = $domains; @@ -505,10 +491,10 @@ public function getName() * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -532,10 +518,10 @@ public function getIsApproved() * * @return self */ - public function setIsApproved($is_approved) + public function setIsApproved(?bool $is_approved) { if (is_null($is_approved)) { - throw new \InvalidArgumentException('non-nullable is_approved cannot be null'); + throw new InvalidArgumentException('non-nullable is_approved cannot be null'); } $this->container['is_approved'] = $is_approved; @@ -545,7 +531,7 @@ public function setIsApproved($is_approved) /** * Gets oauth * - * @return \Dropbox\Sign\Model\ApiAppResponseOAuth|null + * @return ApiAppResponseOAuth|null */ public function getOauth() { @@ -555,18 +541,18 @@ public function getOauth() /** * Sets oauth * - * @param \Dropbox\Sign\Model\ApiAppResponseOAuth|null $oauth oauth + * @param ApiAppResponseOAuth|null $oauth oauth * * @return self */ - public function setOauth($oauth) + public function setOauth(?ApiAppResponseOAuth $oauth) { if (is_null($oauth)) { array_push($this->openAPINullablesSetToNull, 'oauth'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('oauth', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -579,7 +565,7 @@ public function setOauth($oauth) /** * Gets options * - * @return \Dropbox\Sign\Model\ApiAppResponseOptions|null + * @return ApiAppResponseOptions|null */ public function getOptions() { @@ -589,18 +575,18 @@ public function getOptions() /** * Sets options * - * @param \Dropbox\Sign\Model\ApiAppResponseOptions|null $options options + * @param ApiAppResponseOptions|null $options options * * @return self */ - public function setOptions($options) + public function setOptions(?ApiAppResponseOptions $options) { if (is_null($options)) { array_push($this->openAPINullablesSetToNull, 'options'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('options', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -613,7 +599,7 @@ public function setOptions($options) /** * Gets owner_account * - * @return \Dropbox\Sign\Model\ApiAppResponseOwnerAccount|null + * @return ApiAppResponseOwnerAccount|null */ public function getOwnerAccount() { @@ -623,14 +609,14 @@ public function getOwnerAccount() /** * Sets owner_account * - * @param \Dropbox\Sign\Model\ApiAppResponseOwnerAccount|null $owner_account owner_account + * @param ApiAppResponseOwnerAccount|null $owner_account owner_account * * @return self */ - public function setOwnerAccount($owner_account) + public function setOwnerAccount(?ApiAppResponseOwnerAccount $owner_account) { if (is_null($owner_account)) { - throw new \InvalidArgumentException('non-nullable owner_account cannot be null'); + throw new InvalidArgumentException('non-nullable owner_account cannot be null'); } $this->container['owner_account'] = $owner_account; @@ -640,7 +626,7 @@ public function setOwnerAccount($owner_account) /** * Gets white_labeling_options * - * @return \Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions|null + * @return ApiAppResponseWhiteLabelingOptions|null */ public function getWhiteLabelingOptions() { @@ -650,18 +636,18 @@ public function getWhiteLabelingOptions() /** * Sets white_labeling_options * - * @param \Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions|null $white_labeling_options white_labeling_options + * @param ApiAppResponseWhiteLabelingOptions|null $white_labeling_options white_labeling_options * * @return self */ - public function setWhiteLabelingOptions($white_labeling_options) + public function setWhiteLabelingOptions(?ApiAppResponseWhiteLabelingOptions $white_labeling_options) { if (is_null($white_labeling_options)) { array_push($this->openAPINullablesSetToNull, 'white_labeling_options'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('white_labeling_options', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -670,14 +656,13 @@ public function setWhiteLabelingOptions($white_labeling_options) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -686,11 +671,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -701,10 +686,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -717,11 +700,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -729,15 +710,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -763,5 +744,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ApiAppResponseOAuth.php b/sdks/php/src/Model/ApiAppResponseOAuth.php index 0b99d7575..ac2ecf08b 100644 --- a/sdks/php/src/Model/ApiAppResponseOAuth.php +++ b/sdks/php/src/Model/ApiAppResponseOAuth.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,73 +27,74 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ApiAppResponseOAuth Class Doc Comment * * @category Class * @description An object describing the app's OAuth properties, or null if OAuth is not configured for the app. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppResponseOAuth implements ModelInterface, ArrayAccess, \JsonSerializable +class ApiAppResponseOAuth implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppResponseOAuth'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'callback_url' => 'string', 'secret' => 'string', 'scopes' => 'string[]', - 'charges_users' => 'bool' + 'charges_users' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'callback_url' => null, 'secret' => null, 'scopes' => null, - 'charges_users' => null + 'charges_users' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'callback_url' => false, 'secret' => true, 'scopes' => false, - 'charges_users' => false + 'charges_users' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,8 +119,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -131,7 +128,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +138,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,9 +147,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -161,9 +155,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool 'callback_url' => 'callback_url', 'secret' => 'secret', 'scopes' => 'scopes', - 'charges_users' => 'charges_users' + 'charges_users' => 'charges_users', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'callback_url' => 'setCallbackUrl', 'secret' => 'setSecret', 'scopes' => 'setScopes', - 'charges_users' => 'setChargesUsers' + 'charges_users' => 'setChargesUsers', ]; /** @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'callback_url' => 'getCallbackUrl', 'secret' => 'getSecret', 'scopes' => 'getScopes', - 'charges_users' => 'getChargesUsers' + 'charges_users' => 'getChargesUsers', ]; /** @@ -248,7 +239,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -270,34 +260,33 @@ public function __construct(array $data = null) $this->setIfExists('charges_users', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ApiAppResponseOAuth { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ApiAppResponseOAuth { /** @var ApiAppResponseOAuth */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ApiAppResponseOAuth::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,9 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -330,7 +317,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets callback_url * @@ -344,14 +330,14 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url The app's OAuth callback URL. + * @param string|null $callback_url the app's OAuth callback URL * * @return self */ - public function setCallbackUrl($callback_url) + public function setCallbackUrl(?string $callback_url) { if (is_null($callback_url)) { - throw new \InvalidArgumentException('non-nullable callback_url cannot be null'); + throw new InvalidArgumentException('non-nullable callback_url cannot be null'); } $this->container['callback_url'] = $callback_url; @@ -371,18 +357,18 @@ public function getSecret() /** * Sets secret * - * @param string|null $secret The app's OAuth secret, or null if the app does not belong to user. + * @param string|null $secret the app's OAuth secret, or null if the app does not belong to user * * @return self */ - public function setSecret($secret) + public function setSecret(?string $secret) { if (is_null($secret)) { array_push($this->openAPINullablesSetToNull, 'secret'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('secret', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -405,14 +391,14 @@ public function getScopes() /** * Sets scopes * - * @param string[]|null $scopes Array of OAuth scopes used by the app. + * @param string[]|null $scopes array of OAuth scopes used by the app * * @return self */ - public function setScopes($scopes) + public function setScopes(?array $scopes) { if (is_null($scopes)) { - throw new \InvalidArgumentException('non-nullable scopes cannot be null'); + throw new InvalidArgumentException('non-nullable scopes cannot be null'); } $this->container['scopes'] = $scopes; @@ -432,27 +418,26 @@ public function getChargesUsers() /** * Sets charges_users * - * @param bool|null $charges_users Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. + * @param bool|null $charges_users boolean indicating whether the app owner or the account granting permission is billed for OAuth requests * * @return self */ - public function setChargesUsers($charges_users) + public function setChargesUsers(?bool $charges_users) { if (is_null($charges_users)) { - throw new \InvalidArgumentException('non-nullable charges_users cannot be null'); + throw new InvalidArgumentException('non-nullable charges_users cannot be null'); } $this->container['charges_users'] = $charges_users; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -461,11 +446,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -476,10 +461,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -492,11 +475,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -504,15 +485,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -538,5 +519,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ApiAppResponseOptions.php b/sdks/php/src/Model/ApiAppResponseOptions.php index 69c935fdd..99c11f02a 100644 --- a/sdks/php/src/Model/ApiAppResponseOptions.php +++ b/sdks/php/src/Model/ApiAppResponseOptions.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,64 +27,65 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ApiAppResponseOptions Class Doc Comment * * @category Class * @description An object with options that override account settings. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppResponseOptions implements ModelInterface, ArrayAccess, \JsonSerializable +class ApiAppResponseOptions implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppResponseOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'can_insert_everywhere' => 'bool' + 'can_insert_everywhere' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'can_insert_everywhere' => null + 'can_insert_everywhere' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'can_insert_everywhere' => false + 'can_insert_everywhere' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -168,7 +159,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'can_insert_everywhere' => 'can_insert_everywhere' + 'can_insert_everywhere' => 'can_insert_everywhere', ]; /** @@ -177,7 +168,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'can_insert_everywhere' => 'setCanInsertEverywhere' + 'can_insert_everywhere' => 'setCanInsertEverywhere', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'can_insert_everywhere' => 'getCanInsertEverywhere' + 'can_insert_everywhere' => 'getCanInsertEverywhere', ]; /** @@ -230,7 +221,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -249,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('can_insert_everywhere', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ApiAppResponseOptions { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ApiAppResponseOptions { /** @var ApiAppResponseOptions */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ApiAppResponseOptions::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +282,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -309,7 +296,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets can_insert_everywhere * @@ -327,23 +313,22 @@ public function getCanInsertEverywhere() * * @return self */ - public function setCanInsertEverywhere($can_insert_everywhere) + public function setCanInsertEverywhere(?bool $can_insert_everywhere) { if (is_null($can_insert_everywhere)) { - throw new \InvalidArgumentException('non-nullable can_insert_everywhere cannot be null'); + throw new InvalidArgumentException('non-nullable can_insert_everywhere cannot be null'); } $this->container['can_insert_everywhere'] = $can_insert_everywhere; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -352,11 +337,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -367,10 +352,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -383,11 +366,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -395,15 +376,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -429,5 +410,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ApiAppResponseOwnerAccount.php b/sdks/php/src/Model/ApiAppResponseOwnerAccount.php index ef2870757..ffc120960 100644 --- a/sdks/php/src/Model/ApiAppResponseOwnerAccount.php +++ b/sdks/php/src/Model/ApiAppResponseOwnerAccount.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,67 +27,68 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ApiAppResponseOwnerAccount Class Doc Comment * * @category Class * @description An object describing the app's owner - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppResponseOwnerAccount implements ModelInterface, ArrayAccess, \JsonSerializable +class ApiAppResponseOwnerAccount implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppResponseOwnerAccount'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', - 'email_address' => 'string' + 'email_address' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, - 'email_address' => null + 'email_address' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account_id' => false, - 'email_address' => false + 'email_address' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -172,7 +163,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account_id' => 'account_id', - 'email_address' => 'email_address' + 'email_address' => 'email_address', ]; /** @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account_id' => 'setAccountId', - 'email_address' => 'setEmailAddress' + 'email_address' => 'setEmailAddress', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account_id' => 'getAccountId', - 'email_address' => 'getEmailAddress' + 'email_address' => 'getEmailAddress', ]; /** @@ -236,7 +227,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -256,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ApiAppResponseOwnerAccount { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ApiAppResponseOwnerAccount { /** @var ApiAppResponseOwnerAccount */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ApiAppResponseOwnerAccount::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,9 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -316,7 +303,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account_id * @@ -334,10 +320,10 @@ public function getAccountId() * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -361,23 +347,22 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -386,11 +371,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -401,10 +386,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -417,11 +400,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -429,15 +410,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -463,5 +444,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php b/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php index 5626d2248..95f29f5f4 100644 --- a/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php +++ b/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ApiAppResponseWhiteLabelingOptions Class Doc Comment * * @category Class * @description An object with options to customize the app's signer page - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppResponseWhiteLabelingOptions implements ModelInterface, ArrayAccess, \JsonSerializable +class ApiAppResponseWhiteLabelingOptions implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppResponseWhiteLabelingOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'header_background_color' => 'string', 'legal_version' => 'string', @@ -72,16 +71,16 @@ class ApiAppResponseWhiteLabelingOptions implements ModelInterface, ArrayAccess, 'secondary_button_text_color' => 'string', 'secondary_button_text_color_hover' => 'string', 'text_color1' => 'string', - 'text_color2' => 'string' + 'text_color2' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'header_background_color' => null, 'legal_version' => null, @@ -96,14 +95,14 @@ class ApiAppResponseWhiteLabelingOptions implements ModelInterface, ArrayAccess, 'secondary_button_text_color' => null, 'secondary_button_text_color_hover' => null, 'text_color1' => null, - 'text_color2' => null + 'text_color2' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'header_background_color' => false, 'legal_version' => false, @@ -118,14 +117,14 @@ class ApiAppResponseWhiteLabelingOptions implements ModelInterface, ArrayAccess, 'secondary_button_text_color' => false, 'secondary_button_text_color_hover' => false, 'text_color1' => false, - 'text_color2' => false + 'text_color2' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -150,8 +149,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -161,7 +158,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -171,7 +168,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -180,9 +177,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -191,9 +185,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -220,7 +211,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color' => 'secondary_button_text_color', 'secondary_button_text_color_hover' => 'secondary_button_text_color_hover', 'text_color1' => 'text_color1', - 'text_color2' => 'text_color2' + 'text_color2' => 'text_color2', ]; /** @@ -242,7 +233,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color' => 'setSecondaryButtonTextColor', 'secondary_button_text_color_hover' => 'setSecondaryButtonTextColorHover', 'text_color1' => 'setTextColor1', - 'text_color2' => 'setTextColor2' + 'text_color2' => 'setTextColor2', ]; /** @@ -264,7 +255,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color' => 'getSecondaryButtonTextColor', 'secondary_button_text_color_hover' => 'getSecondaryButtonTextColorHover', 'text_color1' => 'getTextColor1', - 'text_color2' => 'getTextColor2' + 'text_color2' => 'getTextColor2', ]; /** @@ -308,7 +299,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -340,34 +330,33 @@ public function __construct(array $data = null) $this->setIfExists('text_color2', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ApiAppResponseWhiteLabelingOptions { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ApiAppResponseWhiteLabelingOptions { /** @var ApiAppResponseWhiteLabelingOptions */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ApiAppResponseWhiteLabelingOptions::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -384,9 +373,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -400,7 +387,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets header_background_color * @@ -418,10 +404,10 @@ public function getHeaderBackgroundColor() * * @return self */ - public function setHeaderBackgroundColor($header_background_color) + public function setHeaderBackgroundColor(?string $header_background_color) { if (is_null($header_background_color)) { - throw new \InvalidArgumentException('non-nullable header_background_color cannot be null'); + throw new InvalidArgumentException('non-nullable header_background_color cannot be null'); } $this->container['header_background_color'] = $header_background_color; @@ -445,10 +431,10 @@ public function getLegalVersion() * * @return self */ - public function setLegalVersion($legal_version) + public function setLegalVersion(?string $legal_version) { if (is_null($legal_version)) { - throw new \InvalidArgumentException('non-nullable legal_version cannot be null'); + throw new InvalidArgumentException('non-nullable legal_version cannot be null'); } $this->container['legal_version'] = $legal_version; @@ -472,10 +458,10 @@ public function getLinkColor() * * @return self */ - public function setLinkColor($link_color) + public function setLinkColor(?string $link_color) { if (is_null($link_color)) { - throw new \InvalidArgumentException('non-nullable link_color cannot be null'); + throw new InvalidArgumentException('non-nullable link_color cannot be null'); } $this->container['link_color'] = $link_color; @@ -499,10 +485,10 @@ public function getPageBackgroundColor() * * @return self */ - public function setPageBackgroundColor($page_background_color) + public function setPageBackgroundColor(?string $page_background_color) { if (is_null($page_background_color)) { - throw new \InvalidArgumentException('non-nullable page_background_color cannot be null'); + throw new InvalidArgumentException('non-nullable page_background_color cannot be null'); } $this->container['page_background_color'] = $page_background_color; @@ -526,10 +512,10 @@ public function getPrimaryButtonColor() * * @return self */ - public function setPrimaryButtonColor($primary_button_color) + public function setPrimaryButtonColor(?string $primary_button_color) { if (is_null($primary_button_color)) { - throw new \InvalidArgumentException('non-nullable primary_button_color cannot be null'); + throw new InvalidArgumentException('non-nullable primary_button_color cannot be null'); } $this->container['primary_button_color'] = $primary_button_color; @@ -553,10 +539,10 @@ public function getPrimaryButtonColorHover() * * @return self */ - public function setPrimaryButtonColorHover($primary_button_color_hover) + public function setPrimaryButtonColorHover(?string $primary_button_color_hover) { if (is_null($primary_button_color_hover)) { - throw new \InvalidArgumentException('non-nullable primary_button_color_hover cannot be null'); + throw new InvalidArgumentException('non-nullable primary_button_color_hover cannot be null'); } $this->container['primary_button_color_hover'] = $primary_button_color_hover; @@ -580,10 +566,10 @@ public function getPrimaryButtonTextColor() * * @return self */ - public function setPrimaryButtonTextColor($primary_button_text_color) + public function setPrimaryButtonTextColor(?string $primary_button_text_color) { if (is_null($primary_button_text_color)) { - throw new \InvalidArgumentException('non-nullable primary_button_text_color cannot be null'); + throw new InvalidArgumentException('non-nullable primary_button_text_color cannot be null'); } $this->container['primary_button_text_color'] = $primary_button_text_color; @@ -607,10 +593,10 @@ public function getPrimaryButtonTextColorHover() * * @return self */ - public function setPrimaryButtonTextColorHover($primary_button_text_color_hover) + public function setPrimaryButtonTextColorHover(?string $primary_button_text_color_hover) { if (is_null($primary_button_text_color_hover)) { - throw new \InvalidArgumentException('non-nullable primary_button_text_color_hover cannot be null'); + throw new InvalidArgumentException('non-nullable primary_button_text_color_hover cannot be null'); } $this->container['primary_button_text_color_hover'] = $primary_button_text_color_hover; @@ -634,10 +620,10 @@ public function getSecondaryButtonColor() * * @return self */ - public function setSecondaryButtonColor($secondary_button_color) + public function setSecondaryButtonColor(?string $secondary_button_color) { if (is_null($secondary_button_color)) { - throw new \InvalidArgumentException('non-nullable secondary_button_color cannot be null'); + throw new InvalidArgumentException('non-nullable secondary_button_color cannot be null'); } $this->container['secondary_button_color'] = $secondary_button_color; @@ -661,10 +647,10 @@ public function getSecondaryButtonColorHover() * * @return self */ - public function setSecondaryButtonColorHover($secondary_button_color_hover) + public function setSecondaryButtonColorHover(?string $secondary_button_color_hover) { if (is_null($secondary_button_color_hover)) { - throw new \InvalidArgumentException('non-nullable secondary_button_color_hover cannot be null'); + throw new InvalidArgumentException('non-nullable secondary_button_color_hover cannot be null'); } $this->container['secondary_button_color_hover'] = $secondary_button_color_hover; @@ -688,10 +674,10 @@ public function getSecondaryButtonTextColor() * * @return self */ - public function setSecondaryButtonTextColor($secondary_button_text_color) + public function setSecondaryButtonTextColor(?string $secondary_button_text_color) { if (is_null($secondary_button_text_color)) { - throw new \InvalidArgumentException('non-nullable secondary_button_text_color cannot be null'); + throw new InvalidArgumentException('non-nullable secondary_button_text_color cannot be null'); } $this->container['secondary_button_text_color'] = $secondary_button_text_color; @@ -715,10 +701,10 @@ public function getSecondaryButtonTextColorHover() * * @return self */ - public function setSecondaryButtonTextColorHover($secondary_button_text_color_hover) + public function setSecondaryButtonTextColorHover(?string $secondary_button_text_color_hover) { if (is_null($secondary_button_text_color_hover)) { - throw new \InvalidArgumentException('non-nullable secondary_button_text_color_hover cannot be null'); + throw new InvalidArgumentException('non-nullable secondary_button_text_color_hover cannot be null'); } $this->container['secondary_button_text_color_hover'] = $secondary_button_text_color_hover; @@ -742,10 +728,10 @@ public function getTextColor1() * * @return self */ - public function setTextColor1($text_color1) + public function setTextColor1(?string $text_color1) { if (is_null($text_color1)) { - throw new \InvalidArgumentException('non-nullable text_color1 cannot be null'); + throw new InvalidArgumentException('non-nullable text_color1 cannot be null'); } $this->container['text_color1'] = $text_color1; @@ -769,23 +755,22 @@ public function getTextColor2() * * @return self */ - public function setTextColor2($text_color2) + public function setTextColor2(?string $text_color2) { if (is_null($text_color2)) { - throw new \InvalidArgumentException('non-nullable text_color2 cannot be null'); + throw new InvalidArgumentException('non-nullable text_color2 cannot be null'); } $this->container['text_color2'] = $text_color2; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -794,11 +779,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -809,10 +794,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -825,11 +808,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -837,15 +818,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -871,5 +852,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ApiAppUpdateRequest.php b/sdks/php/src/Model/ApiAppUpdateRequest.php index 77339a104..456d143c2 100644 --- a/sdks/php/src/Model/ApiAppUpdateRequest.php +++ b/sdks/php/src/Model/ApiAppUpdateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * ApiAppUpdateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ApiAppUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class ApiAppUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ApiAppUpdateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'callback_url' => 'string', 'custom_logo_file' => '\SplFileObject', @@ -64,16 +64,16 @@ class ApiAppUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializa 'name' => 'string', 'oauth' => '\Dropbox\Sign\Model\SubOAuth', 'options' => '\Dropbox\Sign\Model\SubOptions', - 'white_labeling_options' => '\Dropbox\Sign\Model\SubWhiteLabelingOptions' + 'white_labeling_options' => '\Dropbox\Sign\Model\SubWhiteLabelingOptions', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'callback_url' => null, 'custom_logo_file' => 'binary', @@ -81,14 +81,14 @@ class ApiAppUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializa 'name' => null, 'oauth' => null, 'options' => null, - 'white_labeling_options' => null + 'white_labeling_options' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'callback_url' => false, 'custom_logo_file' => false, @@ -96,14 +96,14 @@ class ApiAppUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializa 'name' => false, 'oauth' => false, 'options' => false, - 'white_labeling_options' => false + 'white_labeling_options' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -128,8 +128,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -139,7 +137,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -149,7 +147,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -158,9 +156,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -169,9 +164,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -191,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'oauth' => 'oauth', 'options' => 'options', - 'white_labeling_options' => 'white_labeling_options' + 'white_labeling_options' => 'white_labeling_options', ]; /** @@ -206,7 +198,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'oauth' => 'setOauth', 'options' => 'setOptions', - 'white_labeling_options' => 'setWhiteLabelingOptions' + 'white_labeling_options' => 'setWhiteLabelingOptions', ]; /** @@ -221,7 +213,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'oauth' => 'getOauth', 'options' => 'getOptions', - 'white_labeling_options' => 'getWhiteLabelingOptions' + 'white_labeling_options' => 'getWhiteLabelingOptions', ]; /** @@ -265,7 +257,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -290,34 +281,33 @@ public function __construct(array $data = null) $this->setIfExists('white_labeling_options', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ApiAppUpdateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ApiAppUpdateRequest { /** @var ApiAppUpdateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ApiAppUpdateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -354,7 +344,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets callback_url * @@ -368,14 +357,14 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url The URL at which the API App should receive event callbacks. + * @param string|null $callback_url the URL at which the API App should receive event callbacks * * @return self */ - public function setCallbackUrl($callback_url) + public function setCallbackUrl(?string $callback_url) { if (is_null($callback_url)) { - throw new \InvalidArgumentException('non-nullable callback_url cannot be null'); + throw new InvalidArgumentException('non-nullable callback_url cannot be null'); } $this->container['callback_url'] = $callback_url; @@ -385,7 +374,7 @@ public function setCallbackUrl($callback_url) /** * Gets custom_logo_file * - * @return \SplFileObject|null + * @return SplFileObject|null */ public function getCustomLogoFile() { @@ -395,14 +384,14 @@ public function getCustomLogoFile() /** * Sets custom_logo_file * - * @param \SplFileObject|null $custom_logo_file An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) + * @param SplFileObject|null $custom_logo_file An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) * * @return self */ - public function setCustomLogoFile($custom_logo_file) + public function setCustomLogoFile(?SplFileObject $custom_logo_file) { if (is_null($custom_logo_file)) { - throw new \InvalidArgumentException('non-nullable custom_logo_file cannot be null'); + throw new InvalidArgumentException('non-nullable custom_logo_file cannot be null'); } $this->container['custom_logo_file'] = $custom_logo_file; @@ -422,18 +411,18 @@ public function getDomains() /** * Sets domains * - * @param string[]|null $domains The domain names the ApiApp will be associated with. + * @param string[]|null $domains the domain names the ApiApp will be associated with * * @return self */ - public function setDomains($domains) + public function setDomains(?array $domains) { if (is_null($domains)) { - throw new \InvalidArgumentException('non-nullable domains cannot be null'); + throw new InvalidArgumentException('non-nullable domains cannot be null'); } - if ((count($domains) > 2)) { - throw new \InvalidArgumentException('invalid value for $domains when calling ApiAppUpdateRequest., number of items must be less than or equal to 2.'); + if (count($domains) > 2) { + throw new InvalidArgumentException('invalid value for $domains when calling ApiAppUpdateRequest., number of items must be less than or equal to 2.'); } $this->container['domains'] = $domains; @@ -453,14 +442,14 @@ public function getName() /** * Sets name * - * @param string|null $name The name you want to assign to the ApiApp. + * @param string|null $name the name you want to assign to the ApiApp * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -470,7 +459,7 @@ public function setName($name) /** * Gets oauth * - * @return \Dropbox\Sign\Model\SubOAuth|null + * @return SubOAuth|null */ public function getOauth() { @@ -480,14 +469,14 @@ public function getOauth() /** * Sets oauth * - * @param \Dropbox\Sign\Model\SubOAuth|null $oauth oauth + * @param SubOAuth|null $oauth oauth * * @return self */ - public function setOauth($oauth) + public function setOauth(?SubOAuth $oauth) { if (is_null($oauth)) { - throw new \InvalidArgumentException('non-nullable oauth cannot be null'); + throw new InvalidArgumentException('non-nullable oauth cannot be null'); } $this->container['oauth'] = $oauth; @@ -497,7 +486,7 @@ public function setOauth($oauth) /** * Gets options * - * @return \Dropbox\Sign\Model\SubOptions|null + * @return SubOptions|null */ public function getOptions() { @@ -507,14 +496,14 @@ public function getOptions() /** * Sets options * - * @param \Dropbox\Sign\Model\SubOptions|null $options options + * @param SubOptions|null $options options * * @return self */ - public function setOptions($options) + public function setOptions(?SubOptions $options) { if (is_null($options)) { - throw new \InvalidArgumentException('non-nullable options cannot be null'); + throw new InvalidArgumentException('non-nullable options cannot be null'); } $this->container['options'] = $options; @@ -524,7 +513,7 @@ public function setOptions($options) /** * Gets white_labeling_options * - * @return \Dropbox\Sign\Model\SubWhiteLabelingOptions|null + * @return SubWhiteLabelingOptions|null */ public function getWhiteLabelingOptions() { @@ -534,27 +523,26 @@ public function getWhiteLabelingOptions() /** * Sets white_labeling_options * - * @param \Dropbox\Sign\Model\SubWhiteLabelingOptions|null $white_labeling_options white_labeling_options + * @param SubWhiteLabelingOptions|null $white_labeling_options white_labeling_options * * @return self */ - public function setWhiteLabelingOptions($white_labeling_options) + public function setWhiteLabelingOptions(?SubWhiteLabelingOptions $white_labeling_options) { if (is_null($white_labeling_options)) { - throw new \InvalidArgumentException('non-nullable white_labeling_options cannot be null'); + throw new InvalidArgumentException('non-nullable white_labeling_options cannot be null'); } $this->container['white_labeling_options'] = $white_labeling_options; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -563,11 +551,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -578,10 +566,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -594,11 +580,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -606,15 +590,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -640,5 +624,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/BulkSendJobGetResponse.php b/sdks/php/src/Model/BulkSendJobGetResponse.php index 4ebcbc1bb..3d97f3fe5 100644 --- a/sdks/php/src/Model/BulkSendJobGetResponse.php +++ b/sdks/php/src/Model/BulkSendJobGetResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * BulkSendJobGetResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class BulkSendJobGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class BulkSendJobGetResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'BulkSendJobGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'bulk_send_job' => '\Dropbox\Sign\Model\BulkSendJobResponse', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', 'signature_requests' => '\Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[]', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'bulk_send_job' => null, 'list_info' => null, 'signature_requests' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'bulk_send_job' => false, 'list_info' => false, 'signature_requests' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job' => 'bulk_send_job', 'list_info' => 'list_info', 'signature_requests' => 'signature_requests', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job' => 'setBulkSendJob', 'list_info' => 'setListInfo', 'signature_requests' => 'setSignatureRequests', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job' => 'getBulkSendJob', 'list_info' => 'getListInfo', 'signature_requests' => 'getSignatureRequests', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -247,7 +238,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -269,34 +259,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): BulkSendJobGetResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): BulkSendJobGetResponse { /** @var BulkSendJobGetResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, BulkSendJobGetResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -338,11 +327,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets bulk_send_job * - * @return \Dropbox\Sign\Model\BulkSendJobResponse + * @return BulkSendJobResponse */ public function getBulkSendJob() { @@ -352,14 +340,14 @@ public function getBulkSendJob() /** * Sets bulk_send_job * - * @param \Dropbox\Sign\Model\BulkSendJobResponse $bulk_send_job bulk_send_job + * @param BulkSendJobResponse $bulk_send_job bulk_send_job * * @return self */ - public function setBulkSendJob($bulk_send_job) + public function setBulkSendJob(BulkSendJobResponse $bulk_send_job) { if (is_null($bulk_send_job)) { - throw new \InvalidArgumentException('non-nullable bulk_send_job cannot be null'); + throw new InvalidArgumentException('non-nullable bulk_send_job cannot be null'); } $this->container['bulk_send_job'] = $bulk_send_job; @@ -369,7 +357,7 @@ public function setBulkSendJob($bulk_send_job) /** * Gets list_info * - * @return \Dropbox\Sign\Model\ListInfoResponse + * @return ListInfoResponse */ public function getListInfo() { @@ -379,14 +367,14 @@ public function getListInfo() /** * Sets list_info * - * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info + * @param ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo($list_info) + public function setListInfo(ListInfoResponse $list_info) { if (is_null($list_info)) { - throw new \InvalidArgumentException('non-nullable list_info cannot be null'); + throw new InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -396,7 +384,7 @@ public function setListInfo($list_info) /** * Gets signature_requests * - * @return \Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[] + * @return BulkSendJobGetResponseSignatureRequests[] */ public function getSignatureRequests() { @@ -406,14 +394,14 @@ public function getSignatureRequests() /** * Sets signature_requests * - * @param \Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[] $signature_requests Contains information about the Signature Requests sent in bulk. + * @param BulkSendJobGetResponseSignatureRequests[] $signature_requests contains information about the Signature Requests sent in bulk * * @return self */ - public function setSignatureRequests($signature_requests) + public function setSignatureRequests(array $signature_requests) { if (is_null($signature_requests)) { - throw new \InvalidArgumentException('non-nullable signature_requests cannot be null'); + throw new InvalidArgumentException('non-nullable signature_requests cannot be null'); } $this->container['signature_requests'] = $signature_requests; @@ -423,7 +411,7 @@ public function setSignatureRequests($signature_requests) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -433,27 +421,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -462,11 +449,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -477,10 +464,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -493,11 +478,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -505,15 +488,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -539,5 +522,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php b/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php index b7ab1008a..0781348c0 100644 --- a/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php +++ b/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,35 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * BulkSendJobGetResponseSignatureRequests Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAccess, \JsonSerializable +class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'BulkSendJobGetResponseSignatureRequests'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'test_mode' => 'bool', 'signature_request_id' => 'string', @@ -82,16 +81,16 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', 'response_data' => '\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]', 'signatures' => '\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]', - 'bulk_send_job_id' => 'string' + 'bulk_send_job_id' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'test_mode' => null, 'signature_request_id' => null, @@ -117,14 +116,14 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc 'attachments' => null, 'response_data' => null, 'signatures' => null, - 'bulk_send_job_id' => null + 'bulk_send_job_id' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'test_mode' => false, 'signature_request_id' => false, @@ -150,14 +149,14 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc 'attachments' => true, 'response_data' => true, 'signatures' => false, - 'bulk_send_job_id' => false + 'bulk_send_job_id' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -182,8 +181,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -193,7 +190,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -203,7 +200,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -212,9 +209,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -223,9 +217,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -263,7 +254,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'attachments', 'response_data' => 'response_data', 'signatures' => 'signatures', - 'bulk_send_job_id' => 'bulk_send_job_id' + 'bulk_send_job_id' => 'bulk_send_job_id', ]; /** @@ -296,7 +287,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'setAttachments', 'response_data' => 'setResponseData', 'signatures' => 'setSignatures', - 'bulk_send_job_id' => 'setBulkSendJobId' + 'bulk_send_job_id' => 'setBulkSendJobId', ]; /** @@ -329,7 +320,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'getAttachments', 'response_data' => 'getResponseData', 'signatures' => 'getSignatures', - 'bulk_send_job_id' => 'getBulkSendJobId' + 'bulk_send_job_id' => 'getBulkSendJobId', ]; /** @@ -373,7 +364,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -416,34 +406,33 @@ public function __construct(array $data = null) $this->setIfExists('bulk_send_job_id', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): BulkSendJobGetResponseSignatureRequests { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): BulkSendJobGetResponseSignatureRequests { /** @var BulkSendJobGetResponseSignatureRequests */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, BulkSendJobGetResponseSignatureRequests::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -460,9 +449,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -476,7 +463,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets test_mode * @@ -494,10 +480,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -517,14 +503,14 @@ public function getSignatureRequestId() /** * Sets signature_request_id * - * @param string|null $signature_request_id The id of the SignatureRequest. + * @param string|null $signature_request_id the id of the SignatureRequest * * @return self */ - public function setSignatureRequestId($signature_request_id) + public function setSignatureRequestId(?string $signature_request_id) { if (is_null($signature_request_id)) { - throw new \InvalidArgumentException('non-nullable signature_request_id cannot be null'); + throw new InvalidArgumentException('non-nullable signature_request_id cannot be null'); } $this->container['signature_request_id'] = $signature_request_id; @@ -544,18 +530,18 @@ public function getRequesterEmailAddress() /** * Sets requester_email_address * - * @param string|null $requester_email_address The email address of the initiator of the SignatureRequest. + * @param string|null $requester_email_address the email address of the initiator of the SignatureRequest * * @return self */ - public function setRequesterEmailAddress($requester_email_address) + public function setRequesterEmailAddress(?string $requester_email_address) { if (is_null($requester_email_address)) { array_push($this->openAPINullablesSetToNull, 'requester_email_address'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('requester_email_address', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -578,14 +564,14 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title the specified Account uses for the SignatureRequest. + * @param string|null $title the title the specified Account uses for the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -605,14 +591,14 @@ public function getOriginalTitle() /** * Sets original_title * - * @param string|null $original_title Default Label for account. + * @param string|null $original_title default Label for account * * @return self */ - public function setOriginalTitle($original_title) + public function setOriginalTitle(?string $original_title) { if (is_null($original_title)) { - throw new \InvalidArgumentException('non-nullable original_title cannot be null'); + throw new InvalidArgumentException('non-nullable original_title cannot be null'); } $this->container['original_title'] = $original_title; @@ -632,18 +618,18 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that was initially sent to the signers. + * @param string|null $subject the subject in the email that was initially sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { array_push($this->openAPINullablesSetToNull, 'subject'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('subject', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -666,18 +652,18 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that was initially sent to the signers. + * @param string|null $message the custom message in the email that was initially sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { array_push($this->openAPINullablesSetToNull, 'message'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('message', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -700,14 +686,14 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata The metadata attached to the signature request. + * @param array|null $metadata the metadata attached to the signature request * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } $this->container['metadata'] = $metadata; @@ -727,14 +713,14 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at Time the signature request was created. + * @param int|null $created_at time the signature request was created * * @return self */ - public function setCreatedAt($created_at) + public function setCreatedAt(?int $created_at) { if (is_null($created_at)) { - throw new \InvalidArgumentException('non-nullable created_at cannot be null'); + throw new InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; @@ -758,14 +744,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -788,14 +774,14 @@ public function getIsComplete() /** * Sets is_complete * - * @param bool|null $is_complete Whether or not the SignatureRequest has been fully executed by all signers. + * @param bool|null $is_complete whether or not the SignatureRequest has been fully executed by all signers * * @return self */ - public function setIsComplete($is_complete) + public function setIsComplete(?bool $is_complete) { if (is_null($is_complete)) { - throw new \InvalidArgumentException('non-nullable is_complete cannot be null'); + throw new InvalidArgumentException('non-nullable is_complete cannot be null'); } $this->container['is_complete'] = $is_complete; @@ -815,14 +801,14 @@ public function getIsDeclined() /** * Sets is_declined * - * @param bool|null $is_declined Whether or not the SignatureRequest has been declined by a signer. + * @param bool|null $is_declined whether or not the SignatureRequest has been declined by a signer * * @return self */ - public function setIsDeclined($is_declined) + public function setIsDeclined(?bool $is_declined) { if (is_null($is_declined)) { - throw new \InvalidArgumentException('non-nullable is_declined cannot be null'); + throw new InvalidArgumentException('non-nullable is_declined cannot be null'); } $this->container['is_declined'] = $is_declined; @@ -842,14 +828,14 @@ public function getHasError() /** * Sets has_error * - * @param bool|null $has_error Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + * @param bool|null $has_error whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings) * * @return self */ - public function setHasError($has_error) + public function setHasError(?bool $has_error) { if (is_null($has_error)) { - throw new \InvalidArgumentException('non-nullable has_error cannot be null'); + throw new InvalidArgumentException('non-nullable has_error cannot be null'); } $this->container['has_error'] = $has_error; @@ -869,14 +855,14 @@ public function getFilesUrl() /** * Sets files_url * - * @param string|null $files_url The URL where a copy of the request's documents can be downloaded. + * @param string|null $files_url the URL where a copy of the request's documents can be downloaded * * @return self */ - public function setFilesUrl($files_url) + public function setFilesUrl(?string $files_url) { if (is_null($files_url)) { - throw new \InvalidArgumentException('non-nullable files_url cannot be null'); + throw new InvalidArgumentException('non-nullable files_url cannot be null'); } $this->container['files_url'] = $files_url; @@ -900,14 +886,14 @@ public function getSigningUrl() * * @return self */ - public function setSigningUrl($signing_url) + public function setSigningUrl(?string $signing_url) { if (is_null($signing_url)) { array_push($this->openAPINullablesSetToNull, 'signing_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signing_url', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -930,14 +916,14 @@ public function getDetailsUrl() /** * Sets details_url * - * @param string|null $details_url The URL where the requester and the signers can view the current status of the SignatureRequest. + * @param string|null $details_url the URL where the requester and the signers can view the current status of the SignatureRequest * * @return self */ - public function setDetailsUrl($details_url) + public function setDetailsUrl(?string $details_url) { if (is_null($details_url)) { - throw new \InvalidArgumentException('non-nullable details_url cannot be null'); + throw new InvalidArgumentException('non-nullable details_url cannot be null'); } $this->container['details_url'] = $details_url; @@ -961,10 +947,10 @@ public function getCcEmailAddresses() * * @return self */ - public function setCcEmailAddresses($cc_email_addresses) + public function setCcEmailAddresses(?array $cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -984,18 +970,18 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want the signer redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want the signer redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { array_push($this->openAPINullablesSetToNull, 'signing_redirect_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signing_redirect_url', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1022,14 +1008,14 @@ public function getFinalCopyUri() * * @return self */ - public function setFinalCopyUri($final_copy_uri) + public function setFinalCopyUri(?string $final_copy_uri) { if (is_null($final_copy_uri)) { array_push($this->openAPINullablesSetToNull, 'final_copy_uri'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('final_copy_uri', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1052,18 +1038,18 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[]|null $template_ids Templates IDs used in this SignatureRequest (if any). + * @param string[]|null $template_ids templates IDs used in this SignatureRequest (if any) * * @return self */ - public function setTemplateIds($template_ids) + public function setTemplateIds(?array $template_ids) { if (is_null($template_ids)) { array_push($this->openAPINullablesSetToNull, 'template_ids'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('template_ids', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1076,7 +1062,7 @@ public function setTemplateIds($template_ids) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]|null + * @return SignatureRequestResponseCustomFieldBase[]|null */ public function getCustomFields() { @@ -1086,18 +1072,18 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]|null $custom_fields An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * @param SignatureRequestResponseCustomFieldBase[]|null $custom_fields An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { array_push($this->openAPINullablesSetToNull, 'custom_fields'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('custom_fields', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1110,7 +1096,7 @@ public function setCustomFields($custom_fields) /** * Gets attachments * - * @return \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null + * @return SignatureRequestResponseAttachment[]|null */ public function getAttachments() { @@ -1120,18 +1106,18 @@ public function getAttachments() /** * Sets attachments * - * @param \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null $attachments Signer attachments. + * @param SignatureRequestResponseAttachment[]|null $attachments signer attachments * * @return self */ - public function setAttachments($attachments) + public function setAttachments(?array $attachments) { if (is_null($attachments)) { array_push($this->openAPINullablesSetToNull, 'attachments'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('attachments', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1144,7 +1130,7 @@ public function setAttachments($attachments) /** * Gets response_data * - * @return \Dropbox\Sign\Model\SignatureRequestResponseDataBase[]|null + * @return SignatureRequestResponseDataBase[]|null */ public function getResponseData() { @@ -1154,18 +1140,18 @@ public function getResponseData() /** * Sets response_data * - * @param \Dropbox\Sign\Model\SignatureRequestResponseDataBase[]|null $response_data An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + * @param SignatureRequestResponseDataBase[]|null $response_data an array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers * * @return self */ - public function setResponseData($response_data) + public function setResponseData(?array $response_data) { if (is_null($response_data)) { array_push($this->openAPINullablesSetToNull, 'response_data'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('response_data', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1178,7 +1164,7 @@ public function setResponseData($response_data) /** * Gets signatures * - * @return \Dropbox\Sign\Model\SignatureRequestResponseSignatures[]|null + * @return SignatureRequestResponseSignatures[]|null */ public function getSignatures() { @@ -1188,14 +1174,14 @@ public function getSignatures() /** * Sets signatures * - * @param \Dropbox\Sign\Model\SignatureRequestResponseSignatures[]|null $signatures An array of signature objects, 1 for each signer. + * @param SignatureRequestResponseSignatures[]|null $signatures an array of signature objects, 1 for each signer * * @return self */ - public function setSignatures($signatures) + public function setSignatures(?array $signatures) { if (is_null($signatures)) { - throw new \InvalidArgumentException('non-nullable signatures cannot be null'); + throw new InvalidArgumentException('non-nullable signatures cannot be null'); } $this->container['signatures'] = $signatures; @@ -1215,27 +1201,26 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string|null $bulk_send_job_id The id of the BulkSendJob. + * @param string|null $bulk_send_job_id the id of the BulkSendJob * * @return self */ - public function setBulkSendJobId($bulk_send_job_id) + public function setBulkSendJobId(?string $bulk_send_job_id) { if (is_null($bulk_send_job_id)) { - throw new \InvalidArgumentException('non-nullable bulk_send_job_id cannot be null'); + throw new InvalidArgumentException('non-nullable bulk_send_job_id cannot be null'); } $this->container['bulk_send_job_id'] = $bulk_send_job_id; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1244,11 +1229,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1259,10 +1244,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1275,11 +1258,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1287,15 +1268,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1321,5 +1302,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/BulkSendJobListResponse.php b/sdks/php/src/Model/BulkSendJobListResponse.php index 0206d116e..8420c469f 100644 --- a/sdks/php/src/Model/BulkSendJobListResponse.php +++ b/sdks/php/src/Model/BulkSendJobListResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * BulkSendJobListResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class BulkSendJobListResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class BulkSendJobListResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'BulkSendJobListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'bulk_send_jobs' => '\Dropbox\Sign\Model\BulkSendJobResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'bulk_send_jobs' => null, 'list_info' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'bulk_send_jobs' => false, 'list_info' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'bulk_send_jobs' => 'bulk_send_jobs', 'list_info' => 'list_info', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'bulk_send_jobs' => 'setBulkSendJobs', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'bulk_send_jobs' => 'getBulkSendJobs', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): BulkSendJobListResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): BulkSendJobListResponse { /** @var BulkSendJobListResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, BulkSendJobListResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,11 +317,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets bulk_send_jobs * - * @return \Dropbox\Sign\Model\BulkSendJobResponse[] + * @return BulkSendJobResponse[] */ public function getBulkSendJobs() { @@ -342,14 +330,14 @@ public function getBulkSendJobs() /** * Sets bulk_send_jobs * - * @param \Dropbox\Sign\Model\BulkSendJobResponse[] $bulk_send_jobs Contains a list of BulkSendJobs that the API caller has access to. + * @param BulkSendJobResponse[] $bulk_send_jobs contains a list of BulkSendJobs that the API caller has access to * * @return self */ - public function setBulkSendJobs($bulk_send_jobs) + public function setBulkSendJobs(array $bulk_send_jobs) { if (is_null($bulk_send_jobs)) { - throw new \InvalidArgumentException('non-nullable bulk_send_jobs cannot be null'); + throw new InvalidArgumentException('non-nullable bulk_send_jobs cannot be null'); } $this->container['bulk_send_jobs'] = $bulk_send_jobs; @@ -359,7 +347,7 @@ public function setBulkSendJobs($bulk_send_jobs) /** * Gets list_info * - * @return \Dropbox\Sign\Model\ListInfoResponse + * @return ListInfoResponse */ public function getListInfo() { @@ -369,14 +357,14 @@ public function getListInfo() /** * Sets list_info * - * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info + * @param ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo($list_info) + public function setListInfo(ListInfoResponse $list_info) { if (is_null($list_info)) { - throw new \InvalidArgumentException('non-nullable list_info cannot be null'); + throw new InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -386,7 +374,7 @@ public function setListInfo($list_info) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -396,27 +384,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -425,11 +412,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -440,10 +427,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -456,11 +441,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -468,15 +451,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -502,5 +485,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/BulkSendJobResponse.php b/sdks/php/src/Model/BulkSendJobResponse.php index 5a4bd69fc..fcd66e120 100644 --- a/sdks/php/src/Model/BulkSendJobResponse.php +++ b/sdks/php/src/Model/BulkSendJobResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,73 +27,74 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * BulkSendJobResponse Class Doc Comment * * @category Class * @description Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class BulkSendJobResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class BulkSendJobResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'BulkSendJobResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'bulk_send_job_id' => 'string', 'total' => 'int', 'is_creator' => 'bool', - 'created_at' => 'int' + 'created_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'bulk_send_job_id' => null, 'total' => null, 'is_creator' => null, - 'created_at' => null + 'created_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'bulk_send_job_id' => true, 'total' => false, 'is_creator' => false, - 'created_at' => false + 'created_at' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,8 +119,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -131,7 +128,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +138,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,9 +147,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -161,9 +155,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job_id' => 'bulk_send_job_id', 'total' => 'total', 'is_creator' => 'is_creator', - 'created_at' => 'created_at' + 'created_at' => 'created_at', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job_id' => 'setBulkSendJobId', 'total' => 'setTotal', 'is_creator' => 'setIsCreator', - 'created_at' => 'setCreatedAt' + 'created_at' => 'setCreatedAt', ]; /** @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'bulk_send_job_id' => 'getBulkSendJobId', 'total' => 'getTotal', 'is_creator' => 'getIsCreator', - 'created_at' => 'getCreatedAt' + 'created_at' => 'getCreatedAt', ]; /** @@ -248,7 +239,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -270,34 +260,33 @@ public function __construct(array $data = null) $this->setIfExists('created_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): BulkSendJobResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): BulkSendJobResponse { /** @var BulkSendJobResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, BulkSendJobResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,9 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -330,7 +317,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets bulk_send_job_id * @@ -344,18 +330,18 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string|null $bulk_send_job_id The id of the BulkSendJob. + * @param string|null $bulk_send_job_id the id of the BulkSendJob * * @return self */ - public function setBulkSendJobId($bulk_send_job_id) + public function setBulkSendJobId(?string $bulk_send_job_id) { if (is_null($bulk_send_job_id)) { array_push($this->openAPINullablesSetToNull, 'bulk_send_job_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('bulk_send_job_id', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -378,14 +364,14 @@ public function getTotal() /** * Sets total * - * @param int|null $total The total amount of Signature Requests queued for sending. + * @param int|null $total the total amount of Signature Requests queued for sending * * @return self */ - public function setTotal($total) + public function setTotal(?int $total) { if (is_null($total)) { - throw new \InvalidArgumentException('non-nullable total cannot be null'); + throw new InvalidArgumentException('non-nullable total cannot be null'); } $this->container['total'] = $total; @@ -405,14 +391,14 @@ public function getIsCreator() /** * Sets is_creator * - * @param bool|null $is_creator True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. + * @param bool|null $is_creator true if you are the owner of this BulkSendJob, false if it's been shared with you by a team member * * @return self */ - public function setIsCreator($is_creator) + public function setIsCreator(?bool $is_creator) { if (is_null($is_creator)) { - throw new \InvalidArgumentException('non-nullable is_creator cannot be null'); + throw new InvalidArgumentException('non-nullable is_creator cannot be null'); } $this->container['is_creator'] = $is_creator; @@ -432,27 +418,26 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at Time that the BulkSendJob was created. + * @param int|null $created_at time that the BulkSendJob was created * * @return self */ - public function setCreatedAt($created_at) + public function setCreatedAt(?int $created_at) { if (is_null($created_at)) { - throw new \InvalidArgumentException('non-nullable created_at cannot be null'); + throw new InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -461,11 +446,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -476,10 +461,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -492,11 +475,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -504,15 +485,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -538,5 +519,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/BulkSendJobSendResponse.php b/sdks/php/src/Model/BulkSendJobSendResponse.php index a91e1b01b..7797e84c7 100644 --- a/sdks/php/src/Model/BulkSendJobSendResponse.php +++ b/sdks/php/src/Model/BulkSendJobSendResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * BulkSendJobSendResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class BulkSendJobSendResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class BulkSendJobSendResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'BulkSendJobSendResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'bulk_send_job' => '\Dropbox\Sign\Model\BulkSendJobResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'bulk_send_job' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'bulk_send_job' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'bulk_send_job' => 'bulk_send_job', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'bulk_send_job' => 'setBulkSendJob', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'bulk_send_job' => 'getBulkSendJob', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): BulkSendJobSendResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): BulkSendJobSendResponse { /** @var BulkSendJobSendResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, BulkSendJobSendResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets bulk_send_job * - * @return \Dropbox\Sign\Model\BulkSendJobResponse + * @return BulkSendJobResponse */ public function getBulkSendJob() { @@ -332,14 +320,14 @@ public function getBulkSendJob() /** * Sets bulk_send_job * - * @param \Dropbox\Sign\Model\BulkSendJobResponse $bulk_send_job bulk_send_job + * @param BulkSendJobResponse $bulk_send_job bulk_send_job * * @return self */ - public function setBulkSendJob($bulk_send_job) + public function setBulkSendJob(BulkSendJobResponse $bulk_send_job) { if (is_null($bulk_send_job)) { - throw new \InvalidArgumentException('non-nullable bulk_send_job cannot be null'); + throw new InvalidArgumentException('non-nullable bulk_send_job cannot be null'); } $this->container['bulk_send_job'] = $bulk_send_job; @@ -349,7 +337,7 @@ public function setBulkSendJob($bulk_send_job) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/EmbeddedEditUrlRequest.php b/sdks/php/src/Model/EmbeddedEditUrlRequest.php index 5df70bdf1..b4992a4c8 100644 --- a/sdks/php/src/Model/EmbeddedEditUrlRequest.php +++ b/sdks/php/src/Model/EmbeddedEditUrlRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,35 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * EmbeddedEditUrlRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EmbeddedEditUrlRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'allow_edit_ccs' => 'bool', 'cc_roles' => 'string[]', @@ -67,16 +66,16 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, \JsonSerial 'preview_only' => 'bool', 'show_preview' => 'bool', 'show_progress_stepper' => 'bool', - 'test_mode' => 'bool' + 'test_mode' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'allow_edit_ccs' => null, 'cc_roles' => null, @@ -87,14 +86,14 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, \JsonSerial 'preview_only' => null, 'show_preview' => null, 'show_progress_stepper' => null, - 'test_mode' => null + 'test_mode' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'allow_edit_ccs' => false, 'cc_roles' => false, @@ -105,14 +104,14 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, \JsonSerial 'preview_only' => false, 'show_preview' => false, 'show_progress_stepper' => false, - 'test_mode' => false + 'test_mode' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -137,8 +136,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -148,7 +145,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -158,7 +155,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -167,9 +164,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -178,9 +172,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'preview_only' => 'preview_only', 'show_preview' => 'show_preview', 'show_progress_stepper' => 'show_progress_stepper', - 'test_mode' => 'test_mode' + 'test_mode' => 'test_mode', ]; /** @@ -221,7 +212,7 @@ public function isNullableSetToNull(string $property): bool 'preview_only' => 'setPreviewOnly', 'show_preview' => 'setShowPreview', 'show_progress_stepper' => 'setShowProgressStepper', - 'test_mode' => 'setTestMode' + 'test_mode' => 'setTestMode', ]; /** @@ -239,7 +230,7 @@ public function isNullableSetToNull(string $property): bool 'preview_only' => 'getPreviewOnly', 'show_preview' => 'getShowPreview', 'show_progress_stepper' => 'getShowProgressStepper', - 'test_mode' => 'getTestMode' + 'test_mode' => 'getTestMode', ]; /** @@ -283,7 +274,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -311,34 +301,33 @@ public function __construct(array $data = null) $this->setIfExists('test_mode', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): EmbeddedEditUrlRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): EmbeddedEditUrlRequest { /** @var EmbeddedEditUrlRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, EmbeddedEditUrlRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -355,9 +344,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -371,7 +358,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets allow_edit_ccs * @@ -385,14 +371,14 @@ public function getAllowEditCcs() /** * Sets allow_edit_ccs * - * @param bool|null $allow_edit_ccs This allows the requester to enable/disable to add or change CC roles when editing the template. + * @param bool|null $allow_edit_ccs this allows the requester to enable/disable to add or change CC roles when editing the template * * @return self */ - public function setAllowEditCcs($allow_edit_ccs) + public function setAllowEditCcs(?bool $allow_edit_ccs) { if (is_null($allow_edit_ccs)) { - throw new \InvalidArgumentException('non-nullable allow_edit_ccs cannot be null'); + throw new InvalidArgumentException('non-nullable allow_edit_ccs cannot be null'); } $this->container['allow_edit_ccs'] = $allow_edit_ccs; @@ -416,10 +402,10 @@ public function getCcRoles() * * @return self */ - public function setCcRoles($cc_roles) + public function setCcRoles(?array $cc_roles) { if (is_null($cc_roles)) { - throw new \InvalidArgumentException('non-nullable cc_roles cannot be null'); + throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); } $this->container['cc_roles'] = $cc_roles; @@ -429,7 +415,7 @@ public function setCcRoles($cc_roles) /** * Gets editor_options * - * @return \Dropbox\Sign\Model\SubEditorOptions|null + * @return SubEditorOptions|null */ public function getEditorOptions() { @@ -439,14 +425,14 @@ public function getEditorOptions() /** * Sets editor_options * - * @param \Dropbox\Sign\Model\SubEditorOptions|null $editor_options editor_options + * @param SubEditorOptions|null $editor_options editor_options * * @return self */ - public function setEditorOptions($editor_options) + public function setEditorOptions(?SubEditorOptions $editor_options) { if (is_null($editor_options)) { - throw new \InvalidArgumentException('non-nullable editor_options cannot be null'); + throw new InvalidArgumentException('non-nullable editor_options cannot be null'); } $this->container['editor_options'] = $editor_options; @@ -466,14 +452,14 @@ public function getForceSignerRoles() /** * Sets force_signer_roles * - * @param bool|null $force_signer_roles Provide users the ability to review/edit the template signer roles. + * @param bool|null $force_signer_roles provide users the ability to review/edit the template signer roles * * @return self */ - public function setForceSignerRoles($force_signer_roles) + public function setForceSignerRoles(?bool $force_signer_roles) { if (is_null($force_signer_roles)) { - throw new \InvalidArgumentException('non-nullable force_signer_roles cannot be null'); + throw new InvalidArgumentException('non-nullable force_signer_roles cannot be null'); } $this->container['force_signer_roles'] = $force_signer_roles; @@ -493,14 +479,14 @@ public function getForceSubjectMessage() /** * Sets force_subject_message * - * @param bool|null $force_subject_message Provide users the ability to review/edit the template subject and message. + * @param bool|null $force_subject_message provide users the ability to review/edit the template subject and message * * @return self */ - public function setForceSubjectMessage($force_subject_message) + public function setForceSubjectMessage(?bool $force_subject_message) { if (is_null($force_subject_message)) { - throw new \InvalidArgumentException('non-nullable force_subject_message cannot be null'); + throw new InvalidArgumentException('non-nullable force_subject_message cannot be null'); } $this->container['force_subject_message'] = $force_subject_message; @@ -510,7 +496,7 @@ public function setForceSubjectMessage($force_subject_message) /** * Gets merge_fields * - * @return \Dropbox\Sign\Model\SubMergeField[]|null + * @return SubMergeField[]|null */ public function getMergeFields() { @@ -520,14 +506,14 @@ public function getMergeFields() /** * Sets merge_fields * - * @param \Dropbox\Sign\Model\SubMergeField[]|null $merge_fields Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. Remove all merge fields on the template by passing an empty array `[]`. + * @param SubMergeField[]|null $merge_fields Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. Remove all merge fields on the template by passing an empty array `[]`. * * @return self */ - public function setMergeFields($merge_fields) + public function setMergeFields(?array $merge_fields) { if (is_null($merge_fields)) { - throw new \InvalidArgumentException('non-nullable merge_fields cannot be null'); + throw new InvalidArgumentException('non-nullable merge_fields cannot be null'); } $this->container['merge_fields'] = $merge_fields; @@ -551,10 +537,10 @@ public function getPreviewOnly() * * @return self */ - public function setPreviewOnly($preview_only) + public function setPreviewOnly(?bool $preview_only) { if (is_null($preview_only)) { - throw new \InvalidArgumentException('non-nullable preview_only cannot be null'); + throw new InvalidArgumentException('non-nullable preview_only cannot be null'); } $this->container['preview_only'] = $preview_only; @@ -574,14 +560,14 @@ public function getShowPreview() /** * Sets show_preview * - * @param bool|null $show_preview This allows the requester to enable the editor/preview experience. + * @param bool|null $show_preview this allows the requester to enable the editor/preview experience * * @return self */ - public function setShowPreview($show_preview) + public function setShowPreview(?bool $show_preview) { if (is_null($show_preview)) { - throw new \InvalidArgumentException('non-nullable show_preview cannot be null'); + throw new InvalidArgumentException('non-nullable show_preview cannot be null'); } $this->container['show_preview'] = $show_preview; @@ -601,14 +587,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden * * @return self */ - public function setShowProgressStepper($show_progress_stepper) + public function setShowProgressStepper(?bool $show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -632,23 +618,22 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -657,11 +642,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -672,10 +657,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -688,11 +671,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -700,15 +681,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -734,5 +715,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/EmbeddedEditUrlResponse.php b/sdks/php/src/Model/EmbeddedEditUrlResponse.php index 413b0317a..88320ef63 100644 --- a/sdks/php/src/Model/EmbeddedEditUrlResponse.php +++ b/sdks/php/src/Model/EmbeddedEditUrlResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * EmbeddedEditUrlResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class EmbeddedEditUrlResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class EmbeddedEditUrlResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EmbeddedEditUrlResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'embedded' => '\Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'embedded' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'embedded' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'embedded' => 'embedded', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'embedded' => 'setEmbedded', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'embedded' => 'getEmbedded', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): EmbeddedEditUrlResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): EmbeddedEditUrlResponse { /** @var EmbeddedEditUrlResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, EmbeddedEditUrlResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets embedded * - * @return \Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded + * @return EmbeddedEditUrlResponseEmbedded */ public function getEmbedded() { @@ -332,14 +320,14 @@ public function getEmbedded() /** * Sets embedded * - * @param \Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded $embedded embedded + * @param EmbeddedEditUrlResponseEmbedded $embedded embedded * * @return self */ - public function setEmbedded($embedded) + public function setEmbedded(EmbeddedEditUrlResponseEmbedded $embedded) { if (is_null($embedded)) { - throw new \InvalidArgumentException('non-nullable embedded cannot be null'); + throw new InvalidArgumentException('non-nullable embedded cannot be null'); } $this->container['embedded'] = $embedded; @@ -349,7 +337,7 @@ public function setEmbedded($embedded) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php b/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php index 30f0a4649..0ef35374f 100644 --- a/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php +++ b/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,67 +27,68 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * EmbeddedEditUrlResponseEmbedded Class Doc Comment * * @category Class * @description An embedded template object. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class EmbeddedEditUrlResponseEmbedded implements ModelInterface, ArrayAccess, \JsonSerializable +class EmbeddedEditUrlResponseEmbedded implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EmbeddedEditUrlResponseEmbedded'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'edit_url' => 'string', - 'expires_at' => 'int' + 'expires_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'edit_url' => null, - 'expires_at' => null + 'expires_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'edit_url' => false, - 'expires_at' => false + 'expires_at' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -172,7 +163,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'edit_url' => 'edit_url', - 'expires_at' => 'expires_at' + 'expires_at' => 'expires_at', ]; /** @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'edit_url' => 'setEditUrl', - 'expires_at' => 'setExpiresAt' + 'expires_at' => 'setExpiresAt', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'edit_url' => 'getEditUrl', - 'expires_at' => 'getExpiresAt' + 'expires_at' => 'getExpiresAt', ]; /** @@ -236,7 +227,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -256,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): EmbeddedEditUrlResponseEmbedded { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): EmbeddedEditUrlResponseEmbedded { /** @var EmbeddedEditUrlResponseEmbedded */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, EmbeddedEditUrlResponseEmbedded::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,9 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -316,7 +303,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets edit_url * @@ -330,14 +316,14 @@ public function getEditUrl() /** * Sets edit_url * - * @param string|null $edit_url A template url that can be opened in an iFrame. + * @param string|null $edit_url a template url that can be opened in an iFrame * * @return self */ - public function setEditUrl($edit_url) + public function setEditUrl(?string $edit_url) { if (is_null($edit_url)) { - throw new \InvalidArgumentException('non-nullable edit_url cannot be null'); + throw new InvalidArgumentException('non-nullable edit_url cannot be null'); } $this->container['edit_url'] = $edit_url; @@ -357,27 +343,26 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at The specific time that the the `edit_url` link expires, in epoch. + * @param int|null $expires_at the specific time that the the `edit_url` link expires, in epoch * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { - throw new \InvalidArgumentException('non-nullable expires_at cannot be null'); + throw new InvalidArgumentException('non-nullable expires_at cannot be null'); } $this->container['expires_at'] = $expires_at; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -386,11 +371,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -401,10 +386,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -417,11 +400,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -429,15 +410,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -463,5 +444,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/EmbeddedSignUrlResponse.php b/sdks/php/src/Model/EmbeddedSignUrlResponse.php index e2e7dc89a..4f91647aa 100644 --- a/sdks/php/src/Model/EmbeddedSignUrlResponse.php +++ b/sdks/php/src/Model/EmbeddedSignUrlResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * EmbeddedSignUrlResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class EmbeddedSignUrlResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class EmbeddedSignUrlResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EmbeddedSignUrlResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'embedded' => '\Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'embedded' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'embedded' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'embedded' => 'embedded', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'embedded' => 'setEmbedded', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'embedded' => 'getEmbedded', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): EmbeddedSignUrlResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): EmbeddedSignUrlResponse { /** @var EmbeddedSignUrlResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, EmbeddedSignUrlResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets embedded * - * @return \Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded + * @return EmbeddedSignUrlResponseEmbedded */ public function getEmbedded() { @@ -332,14 +320,14 @@ public function getEmbedded() /** * Sets embedded * - * @param \Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded $embedded embedded + * @param EmbeddedSignUrlResponseEmbedded $embedded embedded * * @return self */ - public function setEmbedded($embedded) + public function setEmbedded(EmbeddedSignUrlResponseEmbedded $embedded) { if (is_null($embedded)) { - throw new \InvalidArgumentException('non-nullable embedded cannot be null'); + throw new InvalidArgumentException('non-nullable embedded cannot be null'); } $this->container['embedded'] = $embedded; @@ -349,7 +337,7 @@ public function setEmbedded($embedded) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php b/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php index 27d64cb28..f8b6619ba 100644 --- a/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php +++ b/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,67 +27,68 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * EmbeddedSignUrlResponseEmbedded Class Doc Comment * * @category Class * @description An object that contains necessary information to set up embedded signing. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class EmbeddedSignUrlResponseEmbedded implements ModelInterface, ArrayAccess, \JsonSerializable +class EmbeddedSignUrlResponseEmbedded implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EmbeddedSignUrlResponseEmbedded'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'sign_url' => 'string', - 'expires_at' => 'int' + 'expires_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'sign_url' => null, - 'expires_at' => null + 'expires_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'sign_url' => false, - 'expires_at' => false + 'expires_at' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -172,7 +163,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'sign_url' => 'sign_url', - 'expires_at' => 'expires_at' + 'expires_at' => 'expires_at', ]; /** @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'sign_url' => 'setSignUrl', - 'expires_at' => 'setExpiresAt' + 'expires_at' => 'setExpiresAt', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'sign_url' => 'getSignUrl', - 'expires_at' => 'getExpiresAt' + 'expires_at' => 'getExpiresAt', ]; /** @@ -236,7 +227,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -256,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): EmbeddedSignUrlResponseEmbedded { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): EmbeddedSignUrlResponseEmbedded { /** @var EmbeddedSignUrlResponseEmbedded */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, EmbeddedSignUrlResponseEmbedded::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,9 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -316,7 +303,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets sign_url * @@ -330,14 +316,14 @@ public function getSignUrl() /** * Sets sign_url * - * @param string|null $sign_url A signature url that can be opened in an iFrame. + * @param string|null $sign_url a signature url that can be opened in an iFrame * * @return self */ - public function setSignUrl($sign_url) + public function setSignUrl(?string $sign_url) { if (is_null($sign_url)) { - throw new \InvalidArgumentException('non-nullable sign_url cannot be null'); + throw new InvalidArgumentException('non-nullable sign_url cannot be null'); } $this->container['sign_url'] = $sign_url; @@ -357,27 +343,26 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at The specific time that the the `sign_url` link expires, in epoch. + * @param int|null $expires_at the specific time that the the `sign_url` link expires, in epoch * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { - throw new \InvalidArgumentException('non-nullable expires_at cannot be null'); + throw new InvalidArgumentException('non-nullable expires_at cannot be null'); } $this->container['expires_at'] = $expires_at; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -386,11 +371,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -401,10 +386,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -417,11 +400,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -429,15 +410,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -463,5 +444,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ErrorResponse.php b/sdks/php/src/Model/ErrorResponse.php index 90fe0ec84..081ed78c0 100644 --- a/sdks/php/src/Model/ErrorResponse.php +++ b/sdks/php/src/Model/ErrorResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ErrorResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ErrorResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class ErrorResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ErrorResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'error' => '\Dropbox\Sign\Model\ErrorResponseError' + 'error' => '\Dropbox\Sign\Model\ErrorResponseError', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'error' => null + 'error' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'error' => false + 'error' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'error' => 'error' + 'error' => 'error', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'error' => 'setError' + 'error' => 'setError', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'error' => 'getError' + 'error' => 'getError', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('error', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ErrorResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ErrorResponse { /** @var ErrorResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ErrorResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -311,11 +300,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets error * - * @return \Dropbox\Sign\Model\ErrorResponseError + * @return ErrorResponseError */ public function getError() { @@ -325,27 +313,26 @@ public function getError() /** * Sets error * - * @param \Dropbox\Sign\Model\ErrorResponseError $error error + * @param ErrorResponseError $error error * * @return self */ - public function setError($error) + public function setError(ErrorResponseError $error) { if (is_null($error)) { - throw new \InvalidArgumentException('non-nullable error cannot be null'); + throw new InvalidArgumentException('non-nullable error cannot be null'); } $this->container['error'] = $error; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -354,11 +341,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -369,10 +356,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -385,11 +370,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -397,15 +380,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -431,5 +414,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ErrorResponseError.php b/sdks/php/src/Model/ErrorResponseError.php index eefb72ff1..60981920d 100644 --- a/sdks/php/src/Model/ErrorResponseError.php +++ b/sdks/php/src/Model/ErrorResponseError.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,70 +27,71 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ErrorResponseError Class Doc Comment * * @category Class * @description Contains information about an error that occurred. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ErrorResponseError implements ModelInterface, ArrayAccess, \JsonSerializable +class ErrorResponseError implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ErrorResponseError'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'error_msg' => 'string', 'error_name' => 'string', - 'error_path' => 'string' + 'error_path' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'error_msg' => null, 'error_name' => null, - 'error_path' => null + 'error_path' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'error_msg' => false, 'error_name' => false, - 'error_path' => false + 'error_path' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -117,8 +116,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -128,7 +125,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -138,7 +135,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -147,9 +144,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -158,9 +152,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'error_msg' => 'error_msg', 'error_name' => 'error_name', - 'error_path' => 'error_path' + 'error_path' => 'error_path', ]; /** @@ -187,7 +178,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'error_msg' => 'setErrorMsg', 'error_name' => 'setErrorName', - 'error_path' => 'setErrorPath' + 'error_path' => 'setErrorPath', ]; /** @@ -198,7 +189,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'error_msg' => 'getErrorMsg', 'error_name' => 'getErrorName', - 'error_path' => 'getErrorPath' + 'error_path' => 'getErrorPath', ]; /** @@ -242,7 +233,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -263,34 +253,33 @@ public function __construct(array $data = null) $this->setIfExists('error_path', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ErrorResponseError { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ErrorResponseError { /** @var ErrorResponseError */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ErrorResponseError::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -329,7 +318,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets error_msg * @@ -343,14 +331,14 @@ public function getErrorMsg() /** * Sets error_msg * - * @param string $error_msg Message describing an error. + * @param string $error_msg message describing an error * * @return self */ - public function setErrorMsg($error_msg) + public function setErrorMsg(string $error_msg) { if (is_null($error_msg)) { - throw new \InvalidArgumentException('non-nullable error_msg cannot be null'); + throw new InvalidArgumentException('non-nullable error_msg cannot be null'); } $this->container['error_msg'] = $error_msg; @@ -370,14 +358,14 @@ public function getErrorName() /** * Sets error_name * - * @param string $error_name Name of the error. + * @param string $error_name name of the error * * @return self */ - public function setErrorName($error_name) + public function setErrorName(string $error_name) { if (is_null($error_name)) { - throw new \InvalidArgumentException('non-nullable error_name cannot be null'); + throw new InvalidArgumentException('non-nullable error_name cannot be null'); } $this->container['error_name'] = $error_name; @@ -397,27 +385,26 @@ public function getErrorPath() /** * Sets error_path * - * @param string|null $error_path Path at which an error occurred. + * @param string|null $error_path path at which an error occurred * * @return self */ - public function setErrorPath($error_path) + public function setErrorPath(?string $error_path) { if (is_null($error_path)) { - throw new \InvalidArgumentException('non-nullable error_path cannot be null'); + throw new InvalidArgumentException('non-nullable error_path cannot be null'); } $this->container['error_path'] = $error_path; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -426,11 +413,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -441,10 +428,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -457,11 +442,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -469,15 +452,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -503,5 +486,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/EventCallbackRequest.php b/sdks/php/src/Model/EventCallbackRequest.php index 840fc6b27..35c806b2d 100644 --- a/sdks/php/src/Model/EventCallbackRequest.php +++ b/sdks/php/src/Model/EventCallbackRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * EventCallbackRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class EventCallbackRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class EventCallbackRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EventCallbackRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'event' => '\Dropbox\Sign\Model\EventCallbackRequestEvent', 'account' => '\Dropbox\Sign\Model\AccountResponse', 'signature_request' => '\Dropbox\Sign\Model\SignatureRequestResponse', - 'template' => '\Dropbox\Sign\Model\TemplateResponse' + 'template' => '\Dropbox\Sign\Model\TemplateResponse', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'event' => null, 'account' => null, 'signature_request' => null, - 'template' => null + 'template' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'event' => false, 'account' => false, 'signature_request' => false, - 'template' => false + 'template' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'event' => 'event', 'account' => 'account', 'signature_request' => 'signature_request', - 'template' => 'template' + 'template' => 'template', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'event' => 'setEvent', 'account' => 'setAccount', 'signature_request' => 'setSignatureRequest', - 'template' => 'setTemplate' + 'template' => 'setTemplate', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'event' => 'getEvent', 'account' => 'getAccount', 'signature_request' => 'getSignatureRequest', - 'template' => 'getTemplate' + 'template' => 'getTemplate', ]; /** @@ -247,7 +238,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -269,34 +259,33 @@ public function __construct(array $data = null) $this->setIfExists('template', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): EventCallbackRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): EventCallbackRequest { /** @var EventCallbackRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, EventCallbackRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -332,11 +321,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets event * - * @return \Dropbox\Sign\Model\EventCallbackRequestEvent + * @return EventCallbackRequestEvent */ public function getEvent() { @@ -346,14 +334,14 @@ public function getEvent() /** * Sets event * - * @param \Dropbox\Sign\Model\EventCallbackRequestEvent $event event + * @param EventCallbackRequestEvent $event event * * @return self */ - public function setEvent($event) + public function setEvent(EventCallbackRequestEvent $event) { if (is_null($event)) { - throw new \InvalidArgumentException('non-nullable event cannot be null'); + throw new InvalidArgumentException('non-nullable event cannot be null'); } $this->container['event'] = $event; @@ -363,7 +351,7 @@ public function setEvent($event) /** * Gets account * - * @return \Dropbox\Sign\Model\AccountResponse|null + * @return AccountResponse|null */ public function getAccount() { @@ -373,14 +361,14 @@ public function getAccount() /** * Sets account * - * @param \Dropbox\Sign\Model\AccountResponse|null $account account + * @param AccountResponse|null $account account * * @return self */ - public function setAccount($account) + public function setAccount(?AccountResponse $account) { if (is_null($account)) { - throw new \InvalidArgumentException('non-nullable account cannot be null'); + throw new InvalidArgumentException('non-nullable account cannot be null'); } $this->container['account'] = $account; @@ -390,7 +378,7 @@ public function setAccount($account) /** * Gets signature_request * - * @return \Dropbox\Sign\Model\SignatureRequestResponse|null + * @return SignatureRequestResponse|null */ public function getSignatureRequest() { @@ -400,14 +388,14 @@ public function getSignatureRequest() /** * Sets signature_request * - * @param \Dropbox\Sign\Model\SignatureRequestResponse|null $signature_request signature_request + * @param SignatureRequestResponse|null $signature_request signature_request * * @return self */ - public function setSignatureRequest($signature_request) + public function setSignatureRequest(?SignatureRequestResponse $signature_request) { if (is_null($signature_request)) { - throw new \InvalidArgumentException('non-nullable signature_request cannot be null'); + throw new InvalidArgumentException('non-nullable signature_request cannot be null'); } $this->container['signature_request'] = $signature_request; @@ -417,7 +405,7 @@ public function setSignatureRequest($signature_request) /** * Gets template * - * @return \Dropbox\Sign\Model\TemplateResponse|null + * @return TemplateResponse|null */ public function getTemplate() { @@ -427,27 +415,26 @@ public function getTemplate() /** * Sets template * - * @param \Dropbox\Sign\Model\TemplateResponse|null $template template + * @param TemplateResponse|null $template template * * @return self */ - public function setTemplate($template) + public function setTemplate(?TemplateResponse $template) { if (is_null($template)) { - throw new \InvalidArgumentException('non-nullable template cannot be null'); + throw new InvalidArgumentException('non-nullable template cannot be null'); } $this->container['template'] = $template; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -456,11 +443,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -471,10 +458,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -487,11 +472,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -499,15 +482,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -533,5 +516,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/EventCallbackRequestEvent.php b/sdks/php/src/Model/EventCallbackRequestEvent.php index 35d62f1a1..36d99c767 100644 --- a/sdks/php/src/Model/EventCallbackRequestEvent.php +++ b/sdks/php/src/Model/EventCallbackRequestEvent.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,73 +27,74 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * EventCallbackRequestEvent Class Doc Comment * * @category Class * @description Basic information about the event that occurred. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class EventCallbackRequestEvent implements ModelInterface, ArrayAccess, \JsonSerializable +class EventCallbackRequestEvent implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EventCallbackRequestEvent'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'event_time' => 'string', 'event_type' => 'string', 'event_hash' => 'string', - 'event_metadata' => '\Dropbox\Sign\Model\EventCallbackRequestEventMetadata' + 'event_metadata' => '\Dropbox\Sign\Model\EventCallbackRequestEventMetadata', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'event_time' => null, 'event_type' => null, 'event_hash' => null, - 'event_metadata' => null + 'event_metadata' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'event_time' => false, 'event_type' => false, 'event_hash' => false, - 'event_metadata' => false + 'event_metadata' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,8 +119,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -131,7 +128,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +138,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,9 +147,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -161,9 +155,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool 'event_time' => 'event_time', 'event_type' => 'event_type', 'event_hash' => 'event_hash', - 'event_metadata' => 'event_metadata' + 'event_metadata' => 'event_metadata', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'event_time' => 'setEventTime', 'event_type' => 'setEventType', 'event_hash' => 'setEventHash', - 'event_metadata' => 'setEventMetadata' + 'event_metadata' => 'setEventMetadata', ]; /** @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'event_time' => 'getEventTime', 'event_type' => 'getEventType', 'event_hash' => 'getEventHash', - 'event_metadata' => 'getEventMetadata' + 'event_metadata' => 'getEventMetadata', ]; /** @@ -327,34 +318,33 @@ public function __construct(array $data = null) $this->setIfExists('event_metadata', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): EventCallbackRequestEvent { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): EventCallbackRequestEvent { /** @var EventCallbackRequestEvent */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, EventCallbackRequestEvent::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -405,7 +395,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets event_time * @@ -419,14 +408,14 @@ public function getEventTime() /** * Sets event_time * - * @param string $event_time Time the event was created (using Unix time). + * @param string $event_time time the event was created (using Unix time) * * @return self */ - public function setEventTime($event_time) + public function setEventTime(string $event_time) { if (is_null($event_time)) { - throw new \InvalidArgumentException('non-nullable event_time cannot be null'); + throw new InvalidArgumentException('non-nullable event_time cannot be null'); } $this->container['event_time'] = $event_time; @@ -446,18 +435,18 @@ public function getEventType() /** * Sets event_type * - * @param string $event_type Type of callback event that was triggered. + * @param string $event_type type of callback event that was triggered * * @return self */ - public function setEventType($event_type) + public function setEventType(string $event_type) { if (is_null($event_type)) { - throw new \InvalidArgumentException('non-nullable event_type cannot be null'); + throw new InvalidArgumentException('non-nullable event_type cannot be null'); } $allowedValues = $this->getEventTypeAllowableValues(); if (!in_array($event_type, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'event_type', must be one of '%s'", $event_type, @@ -483,14 +472,14 @@ public function getEventHash() /** * Sets event_hash * - * @param string $event_hash Generated hash used to verify source of event data. + * @param string $event_hash generated hash used to verify source of event data * * @return self */ - public function setEventHash($event_hash) + public function setEventHash(string $event_hash) { if (is_null($event_hash)) { - throw new \InvalidArgumentException('non-nullable event_hash cannot be null'); + throw new InvalidArgumentException('non-nullable event_hash cannot be null'); } $this->container['event_hash'] = $event_hash; @@ -500,7 +489,7 @@ public function setEventHash($event_hash) /** * Gets event_metadata * - * @return \Dropbox\Sign\Model\EventCallbackRequestEventMetadata|null + * @return EventCallbackRequestEventMetadata|null */ public function getEventMetadata() { @@ -510,27 +499,26 @@ public function getEventMetadata() /** * Sets event_metadata * - * @param \Dropbox\Sign\Model\EventCallbackRequestEventMetadata|null $event_metadata event_metadata + * @param EventCallbackRequestEventMetadata|null $event_metadata event_metadata * * @return self */ - public function setEventMetadata($event_metadata) + public function setEventMetadata(?EventCallbackRequestEventMetadata $event_metadata) { if (is_null($event_metadata)) { - throw new \InvalidArgumentException('non-nullable event_metadata cannot be null'); + throw new InvalidArgumentException('non-nullable event_metadata cannot be null'); } $this->container['event_metadata'] = $event_metadata; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -539,11 +527,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -554,10 +542,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -570,11 +556,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -582,15 +566,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -616,5 +600,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/EventCallbackRequestEventMetadata.php b/sdks/php/src/Model/EventCallbackRequestEventMetadata.php index 06146a871..c0d665c8c 100644 --- a/sdks/php/src/Model/EventCallbackRequestEventMetadata.php +++ b/sdks/php/src/Model/EventCallbackRequestEventMetadata.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,73 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use JsonSerializable; +use ReturnTypeWillChange; /** * EventCallbackRequestEventMetadata Class Doc Comment * * @category Class * @description Specific metadata about the event. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class EventCallbackRequestEventMetadata implements ModelInterface, ArrayAccess, \JsonSerializable +class EventCallbackRequestEventMetadata implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'EventCallbackRequestEventMetadata'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'related_signature_id' => 'string', 'reported_for_account_id' => 'string', 'reported_for_app_id' => 'string', - 'event_message' => 'string' + 'event_message' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'related_signature_id' => null, 'reported_for_account_id' => null, 'reported_for_app_id' => null, - 'event_message' => null + 'event_message' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'related_signature_id' => true, 'reported_for_account_id' => true, 'reported_for_app_id' => true, - 'event_message' => true + 'event_message' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -131,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -161,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -180,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'related_signature_id' => 'related_signature_id', 'reported_for_account_id' => 'reported_for_account_id', 'reported_for_app_id' => 'reported_for_app_id', - 'event_message' => 'event_message' + 'event_message' => 'event_message', ]; /** @@ -192,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'related_signature_id' => 'setRelatedSignatureId', 'reported_for_account_id' => 'setReportedForAccountId', 'reported_for_app_id' => 'setReportedForAppId', - 'event_message' => 'setEventMessage' + 'event_message' => 'setEventMessage', ]; /** @@ -204,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'related_signature_id' => 'getRelatedSignatureId', 'reported_for_account_id' => 'getReportedForAccountId', 'reported_for_app_id' => 'getReportedForAppId', - 'event_message' => 'getEventMessage' + 'event_message' => 'getEventMessage', ]; /** @@ -248,7 +238,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -270,34 +259,33 @@ public function __construct(array $data = null) $this->setIfExists('event_message', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): EventCallbackRequestEventMetadata { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): EventCallbackRequestEventMetadata { /** @var EventCallbackRequestEventMetadata */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, EventCallbackRequestEventMetadata::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,9 +302,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -330,7 +316,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets related_signature_id * @@ -348,14 +333,14 @@ public function getRelatedSignatureId() * * @return self */ - public function setRelatedSignatureId($related_signature_id) + public function setRelatedSignatureId(?string $related_signature_id) { if (is_null($related_signature_id)) { array_push($this->openAPINullablesSetToNull, 'related_signature_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('related_signature_id', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -378,18 +363,18 @@ public function getReportedForAccountId() /** * Sets reported_for_account_id * - * @param string|null $reported_for_account_id Account ID the event was reported for. + * @param string|null $reported_for_account_id account ID the event was reported for * * @return self */ - public function setReportedForAccountId($reported_for_account_id) + public function setReportedForAccountId(?string $reported_for_account_id) { if (is_null($reported_for_account_id)) { array_push($this->openAPINullablesSetToNull, 'reported_for_account_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('reported_for_account_id', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -412,18 +397,18 @@ public function getReportedForAppId() /** * Sets reported_for_app_id * - * @param string|null $reported_for_app_id App ID the event was reported for. + * @param string|null $reported_for_app_id app ID the event was reported for * * @return self */ - public function setReportedForAppId($reported_for_app_id) + public function setReportedForAppId(?string $reported_for_app_id) { if (is_null($reported_for_app_id)) { array_push($this->openAPINullablesSetToNull, 'reported_for_app_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('reported_for_app_id', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -446,18 +431,18 @@ public function getEventMessage() /** * Sets event_message * - * @param string|null $event_message Message about a declined or failed (due to error) signature flow. + * @param string|null $event_message message about a declined or failed (due to error) signature flow * * @return self */ - public function setEventMessage($event_message) + public function setEventMessage(?string $event_message) { if (is_null($event_message)) { array_push($this->openAPINullablesSetToNull, 'event_message'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('event_message', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -466,14 +451,13 @@ public function setEventMessage($event_message) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -482,11 +466,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -497,10 +481,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -513,11 +495,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -525,15 +505,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -559,5 +539,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxGetResponse.php b/sdks/php/src/Model/FaxGetResponse.php index 8a620303e..232943492 100644 --- a/sdks/php/src/Model/FaxGetResponse.php +++ b/sdks/php/src/Model/FaxGetResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxGetResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxGetResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'fax' => '\Dropbox\Sign\Model\FaxResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'fax' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'fax' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'fax' => 'fax', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'fax' => 'setFax', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'fax' => 'getFax', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxGetResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxGetResponse { /** @var FaxGetResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxGetResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets fax * - * @return \Dropbox\Sign\Model\FaxResponse + * @return FaxResponse */ public function getFax() { @@ -332,14 +320,14 @@ public function getFax() /** * Sets fax * - * @param \Dropbox\Sign\Model\FaxResponse $fax fax + * @param FaxResponse $fax fax * * @return self */ - public function setFax($fax) + public function setFax(FaxResponse $fax) { if (is_null($fax)) { - throw new \InvalidArgumentException('non-nullable fax cannot be null'); + throw new InvalidArgumentException('non-nullable fax cannot be null'); } $this->container['fax'] = $fax; @@ -349,7 +337,7 @@ public function setFax($fax) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxLineAddUserRequest.php b/sdks/php/src/Model/FaxLineAddUserRequest.php index ef7386518..837f4885d 100644 --- a/sdks/php/src/Model/FaxLineAddUserRequest.php +++ b/sdks/php/src/Model/FaxLineAddUserRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxLineAddUserRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineAddUserRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxLineAddUserRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineAddUserRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'number' => 'string', 'account_id' => 'string', - 'email_address' => 'string' + 'email_address' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'number' => null, 'account_id' => null, - 'email_address' => 'email' + 'email_address' => 'email', ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'number' => false, 'account_id' => false, - 'email_address' => false + 'email_address' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'number' => 'number', 'account_id' => 'account_id', - 'email_address' => 'email_address' + 'email_address' => 'email_address', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'number' => 'setNumber', 'account_id' => 'setAccountId', - 'email_address' => 'setEmailAddress' + 'email_address' => 'setEmailAddress', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'number' => 'getNumber', 'account_id' => 'getAccountId', - 'email_address' => 'getEmailAddress' + 'email_address' => 'getEmailAddress', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxLineAddUserRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxLineAddUserRequest { /** @var FaxLineAddUserRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxLineAddUserRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -325,7 +314,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets number * @@ -343,10 +331,10 @@ public function getNumber() * * @return self */ - public function setNumber($number) + public function setNumber(string $number) { if (is_null($number)) { - throw new \InvalidArgumentException('non-nullable number cannot be null'); + throw new InvalidArgumentException('non-nullable number cannot be null'); } $this->container['number'] = $number; @@ -370,10 +358,10 @@ public function getAccountId() * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -397,23 +385,22 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -422,11 +409,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -437,10 +424,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -453,11 +438,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -465,15 +448,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -499,5 +482,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxLineAreaCodeGetCountryEnum.php b/sdks/php/src/Model/FaxLineAreaCodeGetCountryEnum.php index 32842a253..1b96f68c7 100644 --- a/sdks/php/src/Model/FaxLineAreaCodeGetCountryEnum.php +++ b/sdks/php/src/Model/FaxLineAreaCodeGetCountryEnum.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,12 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; /** * FaxLineAreaCodeGetCountryEnum Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class FaxLineAreaCodeGetCountryEnum { @@ -58,9 +53,7 @@ public static function getAllowableEnumValues() return [ self::CA, self::US, - self::UK + self::UK, ]; } } - - diff --git a/sdks/php/src/Model/FaxLineAreaCodeGetProvinceEnum.php b/sdks/php/src/Model/FaxLineAreaCodeGetProvinceEnum.php index 96bfaa35f..8bfde8747 100644 --- a/sdks/php/src/Model/FaxLineAreaCodeGetProvinceEnum.php +++ b/sdks/php/src/Model/FaxLineAreaCodeGetProvinceEnum.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,12 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; /** * FaxLineAreaCodeGetProvinceEnum Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class FaxLineAreaCodeGetProvinceEnum { @@ -88,9 +83,7 @@ public static function getAllowableEnumValues() self::PE, self::QC, self::SK, - self::YT + self::YT, ]; } } - - diff --git a/sdks/php/src/Model/FaxLineAreaCodeGetResponse.php b/sdks/php/src/Model/FaxLineAreaCodeGetResponse.php index 31223bc13..085e8a8e3 100644 --- a/sdks/php/src/Model/FaxLineAreaCodeGetResponse.php +++ b/sdks/php/src/Model/FaxLineAreaCodeGetResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxLineAreaCodeGetResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineAreaCodeGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxLineAreaCodeGetResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineAreaCodeGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'area_codes' => 'int[]' + 'area_codes' => 'int[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'area_codes' => null + 'area_codes' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'area_codes' => false + 'area_codes' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'area_codes' => 'area_codes' + 'area_codes' => 'area_codes', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'area_codes' => 'setAreaCodes' + 'area_codes' => 'setAreaCodes', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'area_codes' => 'getAreaCodes' + 'area_codes' => 'getAreaCodes', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('area_codes', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxLineAreaCodeGetResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxLineAreaCodeGetResponse { /** @var FaxLineAreaCodeGetResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxLineAreaCodeGetResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -311,7 +300,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets area_codes * @@ -329,23 +317,22 @@ public function getAreaCodes() * * @return self */ - public function setAreaCodes($area_codes) + public function setAreaCodes(array $area_codes) { if (is_null($area_codes)) { - throw new \InvalidArgumentException('non-nullable area_codes cannot be null'); + throw new InvalidArgumentException('non-nullable area_codes cannot be null'); } $this->container['area_codes'] = $area_codes; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -354,11 +341,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -369,10 +356,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -385,11 +370,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -397,15 +380,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -431,5 +414,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxLineAreaCodeGetStateEnum.php b/sdks/php/src/Model/FaxLineAreaCodeGetStateEnum.php index 4e688a545..db4f35fd0 100644 --- a/sdks/php/src/Model/FaxLineAreaCodeGetStateEnum.php +++ b/sdks/php/src/Model/FaxLineAreaCodeGetStateEnum.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,12 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; /** * FaxLineAreaCodeGetStateEnum Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class FaxLineAreaCodeGetStateEnum { @@ -202,9 +197,7 @@ public static function getAllowableEnumValues() self::WA, self::WI, self::WV, - self::WY + self::WY, ]; } } - - diff --git a/sdks/php/src/Model/FaxLineCreateRequest.php b/sdks/php/src/Model/FaxLineCreateRequest.php index 22bd01cd0..5412325a0 100644 --- a/sdks/php/src/Model/FaxLineCreateRequest.php +++ b/sdks/php/src/Model/FaxLineCreateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxLineCreateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxLineCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'area_code' => 'int', 'country' => 'string', 'city' => 'string', - 'account_id' => 'string' + 'account_id' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'area_code' => null, 'country' => null, 'city' => null, - 'account_id' => null + 'account_id' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'area_code' => false, 'country' => false, 'city' => false, - 'account_id' => false + 'account_id' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'area_code' => 'area_code', 'country' => 'country', 'city' => 'city', - 'account_id' => 'account_id' + 'account_id' => 'account_id', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'area_code' => 'setAreaCode', 'country' => 'setCountry', 'city' => 'setCity', - 'account_id' => 'setAccountId' + 'account_id' => 'setAccountId', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'area_code' => 'getAreaCode', 'country' => 'getCountry', 'city' => 'getCity', - 'account_id' => 'getAccountId' + 'account_id' => 'getAccountId', ]; /** @@ -286,34 +277,33 @@ public function __construct(array $data = null) $this->setIfExists('account_id', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxLineCreateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxLineCreateRequest { /** @var FaxLineCreateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxLineCreateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -361,7 +351,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets area_code * @@ -379,10 +368,10 @@ public function getAreaCode() * * @return self */ - public function setAreaCode($area_code) + public function setAreaCode(int $area_code) { if (is_null($area_code)) { - throw new \InvalidArgumentException('non-nullable area_code cannot be null'); + throw new InvalidArgumentException('non-nullable area_code cannot be null'); } $this->container['area_code'] = $area_code; @@ -406,14 +395,14 @@ public function getCountry() * * @return self */ - public function setCountry($country) + public function setCountry(string $country) { if (is_null($country)) { - throw new \InvalidArgumentException('non-nullable country cannot be null'); + throw new InvalidArgumentException('non-nullable country cannot be null'); } $allowedValues = $this->getCountryAllowableValues(); if (!in_array($country, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'country', must be one of '%s'", $country, @@ -443,10 +432,10 @@ public function getCity() * * @return self */ - public function setCity($city) + public function setCity(?string $city) { if (is_null($city)) { - throw new \InvalidArgumentException('non-nullable city cannot be null'); + throw new InvalidArgumentException('non-nullable city cannot be null'); } $this->container['city'] = $city; @@ -470,23 +459,22 @@ public function getAccountId() * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -495,11 +483,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -510,10 +498,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -526,11 +512,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -538,15 +522,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -572,5 +556,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxLineDeleteRequest.php b/sdks/php/src/Model/FaxLineDeleteRequest.php index cc8b60a20..9426ce2af 100644 --- a/sdks/php/src/Model/FaxLineDeleteRequest.php +++ b/sdks/php/src/Model/FaxLineDeleteRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxLineDeleteRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineDeleteRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxLineDeleteRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineDeleteRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'number' => 'string' + 'number' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'number' => null + 'number' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'number' => false + 'number' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'number' => 'number' + 'number' => 'number', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'number' => 'setNumber' + 'number' => 'setNumber', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'number' => 'getNumber' + 'number' => 'getNumber', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('number', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxLineDeleteRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxLineDeleteRequest { /** @var FaxLineDeleteRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxLineDeleteRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -311,7 +300,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets number * @@ -329,23 +317,22 @@ public function getNumber() * * @return self */ - public function setNumber($number) + public function setNumber(string $number) { if (is_null($number)) { - throw new \InvalidArgumentException('non-nullable number cannot be null'); + throw new InvalidArgumentException('non-nullable number cannot be null'); } $this->container['number'] = $number; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -354,11 +341,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -369,10 +356,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -385,11 +370,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -397,15 +380,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -431,5 +414,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxLineListResponse.php b/sdks/php/src/Model/FaxLineListResponse.php index c724e50f8..1b32ad49c 100644 --- a/sdks/php/src/Model/FaxLineListResponse.php +++ b/sdks/php/src/Model/FaxLineListResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxLineListResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineListResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxLineListResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', 'fax_lines' => '\Dropbox\Sign\Model\FaxLineResponseFaxLine[]', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'list_info' => null, 'fax_lines' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'list_info' => false, 'fax_lines' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'list_info' => 'list_info', 'fax_lines' => 'fax_lines', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'list_info' => 'setListInfo', 'fax_lines' => 'setFaxLines', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'list_info' => 'getListInfo', 'fax_lines' => 'getFaxLines', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxLineListResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxLineListResponse { /** @var FaxLineListResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxLineListResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,11 +317,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets list_info * - * @return \Dropbox\Sign\Model\ListInfoResponse + * @return ListInfoResponse */ public function getListInfo() { @@ -342,14 +330,14 @@ public function getListInfo() /** * Sets list_info * - * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info + * @param ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo($list_info) + public function setListInfo(ListInfoResponse $list_info) { if (is_null($list_info)) { - throw new \InvalidArgumentException('non-nullable list_info cannot be null'); + throw new InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -359,7 +347,7 @@ public function setListInfo($list_info) /** * Gets fax_lines * - * @return \Dropbox\Sign\Model\FaxLineResponseFaxLine[] + * @return FaxLineResponseFaxLine[] */ public function getFaxLines() { @@ -369,14 +357,14 @@ public function getFaxLines() /** * Sets fax_lines * - * @param \Dropbox\Sign\Model\FaxLineResponseFaxLine[] $fax_lines fax_lines + * @param FaxLineResponseFaxLine[] $fax_lines fax_lines * * @return self */ - public function setFaxLines($fax_lines) + public function setFaxLines(array $fax_lines) { if (is_null($fax_lines)) { - throw new \InvalidArgumentException('non-nullable fax_lines cannot be null'); + throw new InvalidArgumentException('non-nullable fax_lines cannot be null'); } $this->container['fax_lines'] = $fax_lines; @@ -386,7 +374,7 @@ public function setFaxLines($fax_lines) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse|null + * @return WarningResponse|null */ public function getWarnings() { @@ -396,27 +384,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse|null $warnings warnings + * @param WarningResponse|null $warnings warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?WarningResponse $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -425,11 +412,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -440,10 +427,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -456,11 +441,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -468,15 +451,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -502,5 +485,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxLineRemoveUserRequest.php b/sdks/php/src/Model/FaxLineRemoveUserRequest.php index 127972e3f..560b147e7 100644 --- a/sdks/php/src/Model/FaxLineRemoveUserRequest.php +++ b/sdks/php/src/Model/FaxLineRemoveUserRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxLineRemoveUserRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineRemoveUserRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxLineRemoveUserRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineRemoveUserRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'number' => 'string', 'account_id' => 'string', - 'email_address' => 'string' + 'email_address' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'number' => null, 'account_id' => null, - 'email_address' => 'email' + 'email_address' => 'email', ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'number' => false, 'account_id' => false, - 'email_address' => false + 'email_address' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'number' => 'number', 'account_id' => 'account_id', - 'email_address' => 'email_address' + 'email_address' => 'email_address', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'number' => 'setNumber', 'account_id' => 'setAccountId', - 'email_address' => 'setEmailAddress' + 'email_address' => 'setEmailAddress', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'number' => 'getNumber', 'account_id' => 'getAccountId', - 'email_address' => 'getEmailAddress' + 'email_address' => 'getEmailAddress', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxLineRemoveUserRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxLineRemoveUserRequest { /** @var FaxLineRemoveUserRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxLineRemoveUserRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -325,7 +314,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets number * @@ -343,10 +331,10 @@ public function getNumber() * * @return self */ - public function setNumber($number) + public function setNumber(string $number) { if (is_null($number)) { - throw new \InvalidArgumentException('non-nullable number cannot be null'); + throw new InvalidArgumentException('non-nullable number cannot be null'); } $this->container['number'] = $number; @@ -370,10 +358,10 @@ public function getAccountId() * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -397,23 +385,22 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -422,11 +409,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -437,10 +424,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -453,11 +438,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -465,15 +448,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -499,5 +482,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxLineResponse.php b/sdks/php/src/Model/FaxLineResponse.php index ae2219f3a..c30616f6c 100644 --- a/sdks/php/src/Model/FaxLineResponse.php +++ b/sdks/php/src/Model/FaxLineResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxLineResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxLineResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'fax_line' => '\Dropbox\Sign\Model\FaxLineResponseFaxLine', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'fax_line' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'fax_line' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'fax_line' => 'fax_line', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'fax_line' => 'setFaxLine', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'fax_line' => 'getFaxLine', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxLineResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxLineResponse { /** @var FaxLineResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxLineResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets fax_line * - * @return \Dropbox\Sign\Model\FaxLineResponseFaxLine + * @return FaxLineResponseFaxLine */ public function getFaxLine() { @@ -332,14 +320,14 @@ public function getFaxLine() /** * Sets fax_line * - * @param \Dropbox\Sign\Model\FaxLineResponseFaxLine $fax_line fax_line + * @param FaxLineResponseFaxLine $fax_line fax_line * * @return self */ - public function setFaxLine($fax_line) + public function setFaxLine(FaxLineResponseFaxLine $fax_line) { if (is_null($fax_line)) { - throw new \InvalidArgumentException('non-nullable fax_line cannot be null'); + throw new InvalidArgumentException('non-nullable fax_line cannot be null'); } $this->container['fax_line'] = $fax_line; @@ -349,7 +337,7 @@ public function setFaxLine($fax_line) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse|null + * @return WarningResponse|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse|null $warnings warnings + * @param WarningResponse|null $warnings warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?WarningResponse $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxLineResponseFaxLine.php b/sdks/php/src/Model/FaxLineResponseFaxLine.php index ccb938b82..4a3fe8fa7 100644 --- a/sdks/php/src/Model/FaxLineResponseFaxLine.php +++ b/sdks/php/src/Model/FaxLineResponseFaxLine.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxLineResponseFaxLine Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxLineResponseFaxLine implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxLineResponseFaxLine implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxLineResponseFaxLine'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'number' => 'string', 'created_at' => 'int', 'updated_at' => 'int', - 'accounts' => '\Dropbox\Sign\Model\AccountResponse[]' + 'accounts' => '\Dropbox\Sign\Model\AccountResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'number' => null, 'created_at' => null, 'updated_at' => null, - 'accounts' => null + 'accounts' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'number' => false, 'created_at' => false, 'updated_at' => false, - 'accounts' => false + 'accounts' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'number' => 'number', 'created_at' => 'created_at', 'updated_at' => 'updated_at', - 'accounts' => 'accounts' + 'accounts' => 'accounts', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'number' => 'setNumber', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', - 'accounts' => 'setAccounts' + 'accounts' => 'setAccounts', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'number' => 'getNumber', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', - 'accounts' => 'getAccounts' + 'accounts' => 'getAccounts', ]; /** @@ -247,7 +238,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -269,34 +259,33 @@ public function __construct(array $data = null) $this->setIfExists('accounts', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxLineResponseFaxLine { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxLineResponseFaxLine { /** @var FaxLineResponseFaxLine */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxLineResponseFaxLine::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -313,9 +302,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -329,7 +316,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets number * @@ -347,10 +333,10 @@ public function getNumber() * * @return self */ - public function setNumber($number) + public function setNumber(?string $number) { if (is_null($number)) { - throw new \InvalidArgumentException('non-nullable number cannot be null'); + throw new InvalidArgumentException('non-nullable number cannot be null'); } $this->container['number'] = $number; @@ -374,10 +360,10 @@ public function getCreatedAt() * * @return self */ - public function setCreatedAt($created_at) + public function setCreatedAt(?int $created_at) { if (is_null($created_at)) { - throw new \InvalidArgumentException('non-nullable created_at cannot be null'); + throw new InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; @@ -401,10 +387,10 @@ public function getUpdatedAt() * * @return self */ - public function setUpdatedAt($updated_at) + public function setUpdatedAt(?int $updated_at) { if (is_null($updated_at)) { - throw new \InvalidArgumentException('non-nullable updated_at cannot be null'); + throw new InvalidArgumentException('non-nullable updated_at cannot be null'); } $this->container['updated_at'] = $updated_at; @@ -414,7 +400,7 @@ public function setUpdatedAt($updated_at) /** * Gets accounts * - * @return \Dropbox\Sign\Model\AccountResponse[]|null + * @return AccountResponse[]|null */ public function getAccounts() { @@ -424,27 +410,26 @@ public function getAccounts() /** * Sets accounts * - * @param \Dropbox\Sign\Model\AccountResponse[]|null $accounts accounts + * @param AccountResponse[]|null $accounts accounts * * @return self */ - public function setAccounts($accounts) + public function setAccounts(?array $accounts) { if (is_null($accounts)) { - throw new \InvalidArgumentException('non-nullable accounts cannot be null'); + throw new InvalidArgumentException('non-nullable accounts cannot be null'); } $this->container['accounts'] = $accounts; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -453,11 +438,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -468,10 +453,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -484,11 +467,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -496,15 +477,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -530,5 +511,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxListResponse.php b/sdks/php/src/Model/FaxListResponse.php index f3977d065..21e89d342 100644 --- a/sdks/php/src/Model/FaxListResponse.php +++ b/sdks/php/src/Model/FaxListResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxListResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxListResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxListResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'faxes' => '\Dropbox\Sign\Model\FaxResponse[]', - 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse' + 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'faxes' => null, - 'list_info' => null + 'list_info' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'faxes' => false, - 'list_info' => false + 'list_info' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'faxes' => 'faxes', - 'list_info' => 'list_info' + 'list_info' => 'list_info', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'faxes' => 'setFaxes', - 'list_info' => 'setListInfo' + 'list_info' => 'setListInfo', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'faxes' => 'getFaxes', - 'list_info' => 'getListInfo' + 'list_info' => 'getListInfo', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('list_info', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxListResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxListResponse { /** @var FaxListResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxListResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -321,11 +310,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets faxes * - * @return \Dropbox\Sign\Model\FaxResponse[] + * @return FaxResponse[] */ public function getFaxes() { @@ -335,14 +323,14 @@ public function getFaxes() /** * Sets faxes * - * @param \Dropbox\Sign\Model\FaxResponse[] $faxes faxes + * @param FaxResponse[] $faxes faxes * * @return self */ - public function setFaxes($faxes) + public function setFaxes(array $faxes) { if (is_null($faxes)) { - throw new \InvalidArgumentException('non-nullable faxes cannot be null'); + throw new InvalidArgumentException('non-nullable faxes cannot be null'); } $this->container['faxes'] = $faxes; @@ -352,7 +340,7 @@ public function setFaxes($faxes) /** * Gets list_info * - * @return \Dropbox\Sign\Model\ListInfoResponse + * @return ListInfoResponse */ public function getListInfo() { @@ -362,27 +350,26 @@ public function getListInfo() /** * Sets list_info * - * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info + * @param ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo($list_info) + public function setListInfo(ListInfoResponse $list_info) { if (is_null($list_info)) { - throw new \InvalidArgumentException('non-nullable list_info cannot be null'); + throw new InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -391,11 +378,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -406,10 +393,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -422,11 +407,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -434,15 +417,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -468,5 +451,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxResponse.php b/sdks/php/src/Model/FaxResponse.php index c9688e9f5..9471ccc8a 100644 --- a/sdks/php/src/Model/FaxResponse.php +++ b/sdks/php/src/Model/FaxResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,35 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'fax_id' => 'string', 'title' => 'string', @@ -68,16 +67,16 @@ class FaxResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'transmissions' => '\Dropbox\Sign\Model\FaxResponseTransmission[]', 'subject' => 'string', 'message' => 'string', - 'final_copy_uri' => 'string' + 'final_copy_uri' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'fax_id' => null, 'title' => null, @@ -89,14 +88,14 @@ class FaxResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'transmissions' => null, 'subject' => null, 'message' => null, - 'final_copy_uri' => null + 'final_copy_uri' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'fax_id' => false, 'title' => false, @@ -108,14 +107,14 @@ class FaxResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'transmissions' => false, 'subject' => true, 'message' => true, - 'final_copy_uri' => true + 'final_copy_uri' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -140,8 +139,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -151,7 +148,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -161,7 +158,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -170,9 +167,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -181,9 +175,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -207,7 +198,7 @@ public function isNullableSetToNull(string $property): bool 'transmissions' => 'transmissions', 'subject' => 'subject', 'message' => 'message', - 'final_copy_uri' => 'final_copy_uri' + 'final_copy_uri' => 'final_copy_uri', ]; /** @@ -226,7 +217,7 @@ public function isNullableSetToNull(string $property): bool 'transmissions' => 'setTransmissions', 'subject' => 'setSubject', 'message' => 'setMessage', - 'final_copy_uri' => 'setFinalCopyUri' + 'final_copy_uri' => 'setFinalCopyUri', ]; /** @@ -245,7 +236,7 @@ public function isNullableSetToNull(string $property): bool 'transmissions' => 'getTransmissions', 'subject' => 'getSubject', 'message' => 'getMessage', - 'final_copy_uri' => 'getFinalCopyUri' + 'final_copy_uri' => 'getFinalCopyUri', ]; /** @@ -289,7 +280,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -318,34 +308,33 @@ public function __construct(array $data = null) $this->setIfExists('final_copy_uri', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxResponse { /** @var FaxResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -402,7 +391,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets fax_id * @@ -420,10 +408,10 @@ public function getFaxId() * * @return self */ - public function setFaxId($fax_id) + public function setFaxId(string $fax_id) { if (is_null($fax_id)) { - throw new \InvalidArgumentException('non-nullable fax_id cannot be null'); + throw new InvalidArgumentException('non-nullable fax_id cannot be null'); } $this->container['fax_id'] = $fax_id; @@ -447,10 +435,10 @@ public function getTitle() * * @return self */ - public function setTitle($title) + public function setTitle(string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -474,10 +462,10 @@ public function getOriginalTitle() * * @return self */ - public function setOriginalTitle($original_title) + public function setOriginalTitle(string $original_title) { if (is_null($original_title)) { - throw new \InvalidArgumentException('non-nullable original_title cannot be null'); + throw new InvalidArgumentException('non-nullable original_title cannot be null'); } $this->container['original_title'] = $original_title; @@ -501,10 +489,10 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } $this->container['metadata'] = $metadata; @@ -528,10 +516,10 @@ public function getCreatedAt() * * @return self */ - public function setCreatedAt($created_at) + public function setCreatedAt(int $created_at) { if (is_null($created_at)) { - throw new \InvalidArgumentException('non-nullable created_at cannot be null'); + throw new InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; @@ -555,10 +543,10 @@ public function getSender() * * @return self */ - public function setSender($sender) + public function setSender(string $sender) { if (is_null($sender)) { - throw new \InvalidArgumentException('non-nullable sender cannot be null'); + throw new InvalidArgumentException('non-nullable sender cannot be null'); } $this->container['sender'] = $sender; @@ -582,10 +570,10 @@ public function getFilesUrl() * * @return self */ - public function setFilesUrl($files_url) + public function setFilesUrl(string $files_url) { if (is_null($files_url)) { - throw new \InvalidArgumentException('non-nullable files_url cannot be null'); + throw new InvalidArgumentException('non-nullable files_url cannot be null'); } $this->container['files_url'] = $files_url; @@ -595,7 +583,7 @@ public function setFilesUrl($files_url) /** * Gets transmissions * - * @return \Dropbox\Sign\Model\FaxResponseTransmission[] + * @return FaxResponseTransmission[] */ public function getTransmissions() { @@ -605,14 +593,14 @@ public function getTransmissions() /** * Sets transmissions * - * @param \Dropbox\Sign\Model\FaxResponseTransmission[] $transmissions Fax Transmissions List + * @param FaxResponseTransmission[] $transmissions Fax Transmissions List * * @return self */ - public function setTransmissions($transmissions) + public function setTransmissions(array $transmissions) { if (is_null($transmissions)) { - throw new \InvalidArgumentException('non-nullable transmissions cannot be null'); + throw new InvalidArgumentException('non-nullable transmissions cannot be null'); } $this->container['transmissions'] = $transmissions; @@ -636,14 +624,14 @@ public function getSubject() * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { array_push($this->openAPINullablesSetToNull, 'subject'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('subject', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -670,14 +658,14 @@ public function getMessage() * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { array_push($this->openAPINullablesSetToNull, 'message'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('message', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -704,14 +692,14 @@ public function getFinalCopyUri() * * @return self */ - public function setFinalCopyUri($final_copy_uri) + public function setFinalCopyUri(?string $final_copy_uri) { if (is_null($final_copy_uri)) { array_push($this->openAPINullablesSetToNull, 'final_copy_uri'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('final_copy_uri', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -720,14 +708,13 @@ public function setFinalCopyUri($final_copy_uri) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -736,11 +723,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -751,10 +738,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -767,11 +752,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -779,15 +762,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -813,5 +796,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxResponseTransmission.php b/sdks/php/src/Model/FaxResponseTransmission.php index 9afeb1d1a..8c30b8ad5 100644 --- a/sdks/php/src/Model/FaxResponseTransmission.php +++ b/sdks/php/src/Model/FaxResponseTransmission.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FaxResponseTransmission Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxResponseTransmission implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxResponseTransmission implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxResponseTransmission'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'recipient' => 'string', 'status_code' => 'string', - 'sent_at' => 'int' + 'sent_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'recipient' => null, 'status_code' => null, - 'sent_at' => null + 'sent_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'recipient' => false, 'status_code' => false, - 'sent_at' => false + 'sent_at' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'recipient' => 'recipient', 'status_code' => 'status_code', - 'sent_at' => 'sent_at' + 'sent_at' => 'sent_at', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'recipient' => 'setRecipient', 'status_code' => 'setStatusCode', - 'sent_at' => 'setSentAt' + 'sent_at' => 'setSentAt', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'recipient' => 'getRecipient', 'status_code' => 'getStatusCode', - 'sent_at' => 'getSentAt' + 'sent_at' => 'getSentAt', ]; /** @@ -289,34 +280,33 @@ public function __construct(array $data = null) $this->setIfExists('sent_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxResponseTransmission { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxResponseTransmission { /** @var FaxResponseTransmission */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxResponseTransmission::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -364,7 +354,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets recipient * @@ -382,10 +371,10 @@ public function getRecipient() * * @return self */ - public function setRecipient($recipient) + public function setRecipient(string $recipient) { if (is_null($recipient)) { - throw new \InvalidArgumentException('non-nullable recipient cannot be null'); + throw new InvalidArgumentException('non-nullable recipient cannot be null'); } $this->container['recipient'] = $recipient; @@ -409,14 +398,14 @@ public function getStatusCode() * * @return self */ - public function setStatusCode($status_code) + public function setStatusCode(string $status_code) { if (is_null($status_code)) { - throw new \InvalidArgumentException('non-nullable status_code cannot be null'); + throw new InvalidArgumentException('non-nullable status_code cannot be null'); } $allowedValues = $this->getStatusCodeAllowableValues(); if (!in_array($status_code, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'status_code', must be one of '%s'", $status_code, @@ -446,23 +435,22 @@ public function getSentAt() * * @return self */ - public function setSentAt($sent_at) + public function setSentAt(?int $sent_at) { if (is_null($sent_at)) { - throw new \InvalidArgumentException('non-nullable sent_at cannot be null'); + throw new InvalidArgumentException('non-nullable sent_at cannot be null'); } $this->container['sent_at'] = $sent_at; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -471,11 +459,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -486,10 +474,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -502,11 +488,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -514,15 +498,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -548,5 +532,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FaxSendRequest.php b/sdks/php/src/Model/FaxSendRequest.php index bfd5e9dec..6124050b3 100644 --- a/sdks/php/src/Model/FaxSendRequest.php +++ b/sdks/php/src/Model/FaxSendRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * FaxSendRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FaxSendRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class FaxSendRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FaxSendRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'recipient' => 'string', 'sender' => 'string', @@ -66,16 +66,16 @@ class FaxSendRequest implements ModelInterface, ArrayAccess, \JsonSerializable 'cover_page_to' => 'string', 'cover_page_from' => 'string', 'cover_page_message' => 'string', - 'title' => 'string' + 'title' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'recipient' => null, 'sender' => null, @@ -85,14 +85,14 @@ class FaxSendRequest implements ModelInterface, ArrayAccess, \JsonSerializable 'cover_page_to' => null, 'cover_page_from' => null, 'cover_page_message' => null, - 'title' => null + 'title' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'recipient' => false, 'sender' => false, @@ -102,14 +102,14 @@ class FaxSendRequest implements ModelInterface, ArrayAccess, \JsonSerializable 'cover_page_to' => false, 'cover_page_from' => false, 'cover_page_message' => false, - 'title' => false + 'title' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -134,8 +134,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -145,7 +143,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -155,7 +153,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -164,9 +162,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -175,9 +170,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -199,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'cover_page_to' => 'cover_page_to', 'cover_page_from' => 'cover_page_from', 'cover_page_message' => 'cover_page_message', - 'title' => 'title' + 'title' => 'title', ]; /** @@ -216,7 +208,7 @@ public function isNullableSetToNull(string $property): bool 'cover_page_to' => 'setCoverPageTo', 'cover_page_from' => 'setCoverPageFrom', 'cover_page_message' => 'setCoverPageMessage', - 'title' => 'setTitle' + 'title' => 'setTitle', ]; /** @@ -233,7 +225,7 @@ public function isNullableSetToNull(string $property): bool 'cover_page_to' => 'getCoverPageTo', 'cover_page_from' => 'getCoverPageFrom', 'cover_page_message' => 'getCoverPageMessage', - 'title' => 'getTitle' + 'title' => 'getTitle', ]; /** @@ -277,7 +269,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -304,34 +295,33 @@ public function __construct(array $data = null) $this->setIfExists('title', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FaxSendRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FaxSendRequest { /** @var FaxSendRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FaxSendRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -367,7 +357,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets recipient * @@ -385,10 +374,10 @@ public function getRecipient() * * @return self */ - public function setRecipient($recipient) + public function setRecipient(string $recipient) { if (is_null($recipient)) { - throw new \InvalidArgumentException('non-nullable recipient cannot be null'); + throw new InvalidArgumentException('non-nullable recipient cannot be null'); } $this->container['recipient'] = $recipient; @@ -412,10 +401,10 @@ public function getSender() * * @return self */ - public function setSender($sender) + public function setSender(?string $sender) { if (is_null($sender)) { - throw new \InvalidArgumentException('non-nullable sender cannot be null'); + throw new InvalidArgumentException('non-nullable sender cannot be null'); } $this->container['sender'] = $sender; @@ -425,7 +414,7 @@ public function setSender($sender) /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -435,14 +424,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. + * @param SplFileObject[]|null $files use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -462,14 +451,14 @@ public function getFileUrls() /** * Sets file_urls * - * @param string[]|null $file_urls Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. + * @param string[]|null $file_urls use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -493,10 +482,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -520,10 +509,10 @@ public function getCoverPageTo() * * @return self */ - public function setCoverPageTo($cover_page_to) + public function setCoverPageTo(?string $cover_page_to) { if (is_null($cover_page_to)) { - throw new \InvalidArgumentException('non-nullable cover_page_to cannot be null'); + throw new InvalidArgumentException('non-nullable cover_page_to cannot be null'); } $this->container['cover_page_to'] = $cover_page_to; @@ -547,10 +536,10 @@ public function getCoverPageFrom() * * @return self */ - public function setCoverPageFrom($cover_page_from) + public function setCoverPageFrom(?string $cover_page_from) { if (is_null($cover_page_from)) { - throw new \InvalidArgumentException('non-nullable cover_page_from cannot be null'); + throw new InvalidArgumentException('non-nullable cover_page_from cannot be null'); } $this->container['cover_page_from'] = $cover_page_from; @@ -574,10 +563,10 @@ public function getCoverPageMessage() * * @return self */ - public function setCoverPageMessage($cover_page_message) + public function setCoverPageMessage(?string $cover_page_message) { if (is_null($cover_page_message)) { - throw new \InvalidArgumentException('non-nullable cover_page_message cannot be null'); + throw new InvalidArgumentException('non-nullable cover_page_message cannot be null'); } $this->container['cover_page_message'] = $cover_page_message; @@ -601,23 +590,22 @@ public function getTitle() * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -626,11 +614,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -641,10 +629,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -657,11 +643,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -669,15 +653,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -703,5 +687,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FileResponse.php b/sdks/php/src/Model/FileResponse.php index 0abdabe17..3ebdc3378 100644 --- a/sdks/php/src/Model/FileResponse.php +++ b/sdks/php/src/Model/FileResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FileResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FileResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class FileResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FileResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'file_url' => 'string', - 'expires_at' => 'int' + 'expires_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'file_url' => null, - 'expires_at' => null + 'expires_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'file_url' => false, - 'expires_at' => false + 'expires_at' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'file_url' => 'file_url', - 'expires_at' => 'expires_at' + 'expires_at' => 'expires_at', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'file_url' => 'setFileUrl', - 'expires_at' => 'setExpiresAt' + 'expires_at' => 'setExpiresAt', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'file_url' => 'getFileUrl', - 'expires_at' => 'getExpiresAt' + 'expires_at' => 'getExpiresAt', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FileResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FileResponse { /** @var FileResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FileResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -321,7 +310,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets file_url * @@ -335,14 +323,14 @@ public function getFileUrl() /** * Sets file_url * - * @param string $file_url URL to the file. + * @param string $file_url URL to the file * * @return self */ - public function setFileUrl($file_url) + public function setFileUrl(string $file_url) { if (is_null($file_url)) { - throw new \InvalidArgumentException('non-nullable file_url cannot be null'); + throw new InvalidArgumentException('non-nullable file_url cannot be null'); } $this->container['file_url'] = $file_url; @@ -362,27 +350,26 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int $expires_at When the link expires. + * @param int $expires_at when the link expires * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(int $expires_at) { if (is_null($expires_at)) { - throw new \InvalidArgumentException('non-nullable expires_at cannot be null'); + throw new InvalidArgumentException('non-nullable expires_at cannot be null'); } $this->container['expires_at'] = $expires_at; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -391,11 +378,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -406,10 +393,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -422,11 +407,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -434,15 +417,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -468,5 +451,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/FileResponseDataUri.php b/sdks/php/src/Model/FileResponseDataUri.php index 86a0e0284..474e8a73d 100644 --- a/sdks/php/src/Model/FileResponseDataUri.php +++ b/sdks/php/src/Model/FileResponseDataUri.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * FileResponseDataUri Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class FileResponseDataUri implements ModelInterface, ArrayAccess, \JsonSerializable +class FileResponseDataUri implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'FileResponseDataUri'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'data_uri' => 'string' + 'data_uri' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'data_uri' => null + 'data_uri' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'data_uri' => false + 'data_uri' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'data_uri' => 'data_uri' + 'data_uri' => 'data_uri', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'data_uri' => 'setDataUri' + 'data_uri' => 'setDataUri', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'data_uri' => 'getDataUri' + 'data_uri' => 'getDataUri', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('data_uri', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): FileResponseDataUri { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): FileResponseDataUri { /** @var FileResponseDataUri */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, FileResponseDataUri::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -311,7 +300,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets data_uri * @@ -325,27 +313,26 @@ public function getDataUri() /** * Sets data_uri * - * @param string $data_uri File as base64 encoded string. + * @param string $data_uri file as base64 encoded string * * @return self */ - public function setDataUri($data_uri) + public function setDataUri(string $data_uri) { if (is_null($data_uri)) { - throw new \InvalidArgumentException('non-nullable data_uri cannot be null'); + throw new InvalidArgumentException('non-nullable data_uri cannot be null'); } $this->container['data_uri'] = $data_uri; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -354,11 +341,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -369,10 +356,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -385,11 +370,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -397,15 +380,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -431,5 +414,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ListInfoResponse.php b/sdks/php/src/Model/ListInfoResponse.php index dffd8eacb..623284e41 100644 --- a/sdks/php/src/Model/ListInfoResponse.php +++ b/sdks/php/src/Model/ListInfoResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,73 +27,74 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ListInfoResponse Class Doc Comment * * @category Class * @description Contains pagination information about the data returned. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ListInfoResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class ListInfoResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ListInfoResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'num_pages' => 'int', 'num_results' => 'int', 'page' => 'int', - 'page_size' => 'int' + 'page_size' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'num_pages' => null, 'num_results' => null, 'page' => null, - 'page_size' => null + 'page_size' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'num_pages' => false, 'num_results' => true, 'page' => false, - 'page_size' => false + 'page_size' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,8 +119,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -131,7 +128,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +138,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,9 +147,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -161,9 +155,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool 'num_pages' => 'num_pages', 'num_results' => 'num_results', 'page' => 'page', - 'page_size' => 'page_size' + 'page_size' => 'page_size', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'num_pages' => 'setNumPages', 'num_results' => 'setNumResults', 'page' => 'setPage', - 'page_size' => 'setPageSize' + 'page_size' => 'setPageSize', ]; /** @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'num_pages' => 'getNumPages', 'num_results' => 'getNumResults', 'page' => 'getPage', - 'page_size' => 'getPageSize' + 'page_size' => 'getPageSize', ]; /** @@ -248,7 +239,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -270,34 +260,33 @@ public function __construct(array $data = null) $this->setIfExists('page_size', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ListInfoResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ListInfoResponse { /** @var ListInfoResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ListInfoResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,9 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -330,7 +317,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets num_pages * @@ -344,14 +330,14 @@ public function getNumPages() /** * Sets num_pages * - * @param int|null $num_pages Total number of pages available. + * @param int|null $num_pages total number of pages available * * @return self */ - public function setNumPages($num_pages) + public function setNumPages(?int $num_pages) { if (is_null($num_pages)) { - throw new \InvalidArgumentException('non-nullable num_pages cannot be null'); + throw new InvalidArgumentException('non-nullable num_pages cannot be null'); } $this->container['num_pages'] = $num_pages; @@ -371,18 +357,18 @@ public function getNumResults() /** * Sets num_results * - * @param int|null $num_results Total number of objects available. + * @param int|null $num_results total number of objects available * * @return self */ - public function setNumResults($num_results) + public function setNumResults(?int $num_results) { if (is_null($num_results)) { array_push($this->openAPINullablesSetToNull, 'num_results'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('num_results', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -405,14 +391,14 @@ public function getPage() /** * Sets page * - * @param int|null $page Number of the page being returned. + * @param int|null $page number of the page being returned * * @return self */ - public function setPage($page) + public function setPage(?int $page) { if (is_null($page)) { - throw new \InvalidArgumentException('non-nullable page cannot be null'); + throw new InvalidArgumentException('non-nullable page cannot be null'); } $this->container['page'] = $page; @@ -432,27 +418,26 @@ public function getPageSize() /** * Sets page_size * - * @param int|null $page_size Objects returned per page. + * @param int|null $page_size objects returned per page * * @return self */ - public function setPageSize($page_size) + public function setPageSize(?int $page_size) { if (is_null($page_size)) { - throw new \InvalidArgumentException('non-nullable page_size cannot be null'); + throw new InvalidArgumentException('non-nullable page_size cannot be null'); } $this->container['page_size'] = $page_size; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -461,11 +446,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -476,10 +461,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -492,11 +475,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -504,15 +485,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -538,5 +519,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ModelInterface.php b/sdks/php/src/Model/ModelInterface.php index 4127d706b..0bc2f212e 100644 --- a/sdks/php/src/Model/ModelInterface.php +++ b/sdks/php/src/Model/ModelInterface.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign\Model - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -31,9 +29,6 @@ /** * Interface abstracting model access. - * - * @package Dropbox\Sign\Model - * @author OpenAPI Generator team */ interface ModelInterface { @@ -96,17 +91,11 @@ public function valid(); /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool; /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool; } diff --git a/sdks/php/src/Model/OAuthTokenGenerateRequest.php b/sdks/php/src/Model/OAuthTokenGenerateRequest.php index 0c51ddd3d..38a0395d1 100644 --- a/sdks/php/src/Model/OAuthTokenGenerateRequest.php +++ b/sdks/php/src/Model/OAuthTokenGenerateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,75 +27,76 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * OAuthTokenGenerateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class OAuthTokenGenerateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class OAuthTokenGenerateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'OAuthTokenGenerateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'client_secret' => 'string', 'code' => 'string', 'grant_type' => 'string', - 'state' => 'string' + 'state' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'client_secret' => null, 'code' => null, 'grant_type' => null, - 'state' => null + 'state' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'client_secret' => false, 'code' => false, 'grant_type' => false, - 'state' => false + 'state' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -122,8 +121,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -133,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -143,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -152,9 +149,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -163,9 +157,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -183,7 +174,7 @@ public function isNullableSetToNull(string $property): bool 'client_secret' => 'client_secret', 'code' => 'code', 'grant_type' => 'grant_type', - 'state' => 'state' + 'state' => 'state', ]; /** @@ -196,7 +187,7 @@ public function isNullableSetToNull(string $property): bool 'client_secret' => 'setClientSecret', 'code' => 'setCode', 'grant_type' => 'setGrantType', - 'state' => 'setState' + 'state' => 'setState', ]; /** @@ -209,7 +200,7 @@ public function isNullableSetToNull(string $property): bool 'client_secret' => 'getClientSecret', 'code' => 'getCode', 'grant_type' => 'getGrantType', - 'state' => 'getState' + 'state' => 'getState', ]; /** @@ -253,7 +244,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -276,34 +266,33 @@ public function __construct(array $data = null) $this->setIfExists('state', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): OAuthTokenGenerateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): OAuthTokenGenerateRequest { /** @var OAuthTokenGenerateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, OAuthTokenGenerateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -351,7 +340,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets client_id * @@ -365,14 +353,14 @@ public function getClientId() /** * Sets client_id * - * @param string $client_id The client id of the app requesting authorization. + * @param string $client_id the client id of the app requesting authorization * * @return self */ - public function setClientId($client_id) + public function setClientId(string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -392,14 +380,14 @@ public function getClientSecret() /** * Sets client_secret * - * @param string $client_secret The secret token of your app. + * @param string $client_secret the secret token of your app * * @return self */ - public function setClientSecret($client_secret) + public function setClientSecret(string $client_secret) { if (is_null($client_secret)) { - throw new \InvalidArgumentException('non-nullable client_secret cannot be null'); + throw new InvalidArgumentException('non-nullable client_secret cannot be null'); } $this->container['client_secret'] = $client_secret; @@ -419,14 +407,14 @@ public function getCode() /** * Sets code * - * @param string $code The code passed to your callback when the user granted access. + * @param string $code the code passed to your callback when the user granted access * * @return self */ - public function setCode($code) + public function setCode(string $code) { if (is_null($code)) { - throw new \InvalidArgumentException('non-nullable code cannot be null'); + throw new InvalidArgumentException('non-nullable code cannot be null'); } $this->container['code'] = $code; @@ -446,14 +434,14 @@ public function getGrantType() /** * Sets grant_type * - * @param string $grant_type When generating a new token use `authorization_code`. + * @param string $grant_type when generating a new token use `authorization_code` * * @return self */ - public function setGrantType($grant_type) + public function setGrantType(string $grant_type) { if (is_null($grant_type)) { - throw new \InvalidArgumentException('non-nullable grant_type cannot be null'); + throw new InvalidArgumentException('non-nullable grant_type cannot be null'); } $this->container['grant_type'] = $grant_type; @@ -473,27 +461,26 @@ public function getState() /** * Sets state * - * @param string $state Same as the state you specified earlier. + * @param string $state same as the state you specified earlier * * @return self */ - public function setState($state) + public function setState(string $state) { if (is_null($state)) { - throw new \InvalidArgumentException('non-nullable state cannot be null'); + throw new InvalidArgumentException('non-nullable state cannot be null'); } $this->container['state'] = $state; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -502,11 +489,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -517,10 +504,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -533,11 +518,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -545,15 +528,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -579,5 +562,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/OAuthTokenRefreshRequest.php b/sdks/php/src/Model/OAuthTokenRefreshRequest.php index c92e1700e..11cf05a3b 100644 --- a/sdks/php/src/Model/OAuthTokenRefreshRequest.php +++ b/sdks/php/src/Model/OAuthTokenRefreshRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * OAuthTokenRefreshRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'OAuthTokenRefreshRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'grant_type' => 'string', 'refresh_token' => 'string', 'client_id' => 'string', - 'client_secret' => 'string' + 'client_secret' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'grant_type' => null, 'refresh_token' => null, 'client_id' => null, - 'client_secret' => null + 'client_secret' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'grant_type' => false, 'refresh_token' => false, 'client_id' => false, - 'client_secret' => false + 'client_secret' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'grant_type' => 'grant_type', 'refresh_token' => 'refresh_token', 'client_id' => 'client_id', - 'client_secret' => 'client_secret' + 'client_secret' => 'client_secret', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'grant_type' => 'setGrantType', 'refresh_token' => 'setRefreshToken', 'client_id' => 'setClientId', - 'client_secret' => 'setClientSecret' + 'client_secret' => 'setClientSecret', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'grant_type' => 'getGrantType', 'refresh_token' => 'getRefreshToken', 'client_id' => 'getClientId', - 'client_secret' => 'getClientSecret' + 'client_secret' => 'getClientSecret', ]; /** @@ -247,7 +238,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -269,34 +259,33 @@ public function __construct(array $data = null) $this->setIfExists('client_secret', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): OAuthTokenRefreshRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): OAuthTokenRefreshRequest { /** @var OAuthTokenRefreshRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, OAuthTokenRefreshRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -335,7 +324,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets grant_type * @@ -349,14 +337,14 @@ public function getGrantType() /** * Sets grant_type * - * @param string $grant_type When refreshing an existing token use `refresh_token`. + * @param string $grant_type when refreshing an existing token use `refresh_token` * * @return self */ - public function setGrantType($grant_type) + public function setGrantType(string $grant_type) { if (is_null($grant_type)) { - throw new \InvalidArgumentException('non-nullable grant_type cannot be null'); + throw new InvalidArgumentException('non-nullable grant_type cannot be null'); } $this->container['grant_type'] = $grant_type; @@ -376,14 +364,14 @@ public function getRefreshToken() /** * Sets refresh_token * - * @param string $refresh_token The token provided when you got the expired access token. + * @param string $refresh_token the token provided when you got the expired access token * * @return self */ - public function setRefreshToken($refresh_token) + public function setRefreshToken(string $refresh_token) { if (is_null($refresh_token)) { - throw new \InvalidArgumentException('non-nullable refresh_token cannot be null'); + throw new InvalidArgumentException('non-nullable refresh_token cannot be null'); } $this->container['refresh_token'] = $refresh_token; @@ -407,10 +395,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(?string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -434,23 +422,22 @@ public function getClientSecret() * * @return self */ - public function setClientSecret($client_secret) + public function setClientSecret(?string $client_secret) { if (is_null($client_secret)) { - throw new \InvalidArgumentException('non-nullable client_secret cannot be null'); + throw new InvalidArgumentException('non-nullable client_secret cannot be null'); } $this->container['client_secret'] = $client_secret; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -459,11 +446,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -474,10 +461,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -490,11 +475,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -502,15 +485,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -536,5 +519,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/OAuthTokenResponse.php b/sdks/php/src/Model/OAuthTokenResponse.php index 8b936e6bd..8c83de78e 100644 --- a/sdks/php/src/Model/OAuthTokenResponse.php +++ b/sdks/php/src/Model/OAuthTokenResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,75 +27,76 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * OAuthTokenResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class OAuthTokenResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class OAuthTokenResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'OAuthTokenResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'access_token' => 'string', 'token_type' => 'string', 'refresh_token' => 'string', 'expires_in' => 'int', - 'state' => 'string' + 'state' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'access_token' => null, 'token_type' => null, 'refresh_token' => null, 'expires_in' => null, - 'state' => null + 'state' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'access_token' => false, 'token_type' => false, 'refresh_token' => false, 'expires_in' => false, - 'state' => true + 'state' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -122,8 +121,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -133,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -143,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -152,9 +149,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -163,9 +157,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -183,7 +174,7 @@ public function isNullableSetToNull(string $property): bool 'token_type' => 'token_type', 'refresh_token' => 'refresh_token', 'expires_in' => 'expires_in', - 'state' => 'state' + 'state' => 'state', ]; /** @@ -196,7 +187,7 @@ public function isNullableSetToNull(string $property): bool 'token_type' => 'setTokenType', 'refresh_token' => 'setRefreshToken', 'expires_in' => 'setExpiresIn', - 'state' => 'setState' + 'state' => 'setState', ]; /** @@ -209,7 +200,7 @@ public function isNullableSetToNull(string $property): bool 'token_type' => 'getTokenType', 'refresh_token' => 'getRefreshToken', 'expires_in' => 'getExpiresIn', - 'state' => 'getState' + 'state' => 'getState', ]; /** @@ -253,7 +244,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -276,34 +266,33 @@ public function __construct(array $data = null) $this->setIfExists('state', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): OAuthTokenResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): OAuthTokenResponse { /** @var OAuthTokenResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, OAuthTokenResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -320,9 +309,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -336,7 +323,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets access_token * @@ -354,10 +340,10 @@ public function getAccessToken() * * @return self */ - public function setAccessToken($access_token) + public function setAccessToken(?string $access_token) { if (is_null($access_token)) { - throw new \InvalidArgumentException('non-nullable access_token cannot be null'); + throw new InvalidArgumentException('non-nullable access_token cannot be null'); } $this->container['access_token'] = $access_token; @@ -381,10 +367,10 @@ public function getTokenType() * * @return self */ - public function setTokenType($token_type) + public function setTokenType(?string $token_type) { if (is_null($token_type)) { - throw new \InvalidArgumentException('non-nullable token_type cannot be null'); + throw new InvalidArgumentException('non-nullable token_type cannot be null'); } $this->container['token_type'] = $token_type; @@ -408,10 +394,10 @@ public function getRefreshToken() * * @return self */ - public function setRefreshToken($refresh_token) + public function setRefreshToken(?string $refresh_token) { if (is_null($refresh_token)) { - throw new \InvalidArgumentException('non-nullable refresh_token cannot be null'); + throw new InvalidArgumentException('non-nullable refresh_token cannot be null'); } $this->container['refresh_token'] = $refresh_token; @@ -435,10 +421,10 @@ public function getExpiresIn() * * @return self */ - public function setExpiresIn($expires_in) + public function setExpiresIn(?int $expires_in) { if (is_null($expires_in)) { - throw new \InvalidArgumentException('non-nullable expires_in cannot be null'); + throw new InvalidArgumentException('non-nullable expires_in cannot be null'); } $this->container['expires_in'] = $expires_in; @@ -462,14 +448,14 @@ public function getState() * * @return self */ - public function setState($state) + public function setState(?string $state) { if (is_null($state)) { array_push($this->openAPINullablesSetToNull, 'state'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('state', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -478,14 +464,13 @@ public function setState($state) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -494,11 +479,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -509,10 +494,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -525,11 +508,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -537,15 +518,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -571,5 +552,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ReportCreateRequest.php b/sdks/php/src/Model/ReportCreateRequest.php index 5315d3e9d..58029634b 100644 --- a/sdks/php/src/Model/ReportCreateRequest.php +++ b/sdks/php/src/Model/ReportCreateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ReportCreateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ReportCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class ReportCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ReportCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'end_date' => 'string', 'report_type' => 'string[]', - 'start_date' => 'string' + 'start_date' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'end_date' => null, 'report_type' => null, - 'start_date' => null + 'start_date' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'end_date' => false, 'report_type' => false, - 'start_date' => false + 'start_date' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'end_date' => 'end_date', 'report_type' => 'report_type', - 'start_date' => 'start_date' + 'start_date' => 'start_date', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'end_date' => 'setEndDate', 'report_type' => 'setReportType', - 'start_date' => 'setStartDate' + 'start_date' => 'setStartDate', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'end_date' => 'getEndDate', 'report_type' => 'getReportType', - 'start_date' => 'getStartDate' + 'start_date' => 'getStartDate', ]; /** @@ -277,34 +268,33 @@ public function __construct(array $data = null) $this->setIfExists('start_date', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ReportCreateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ReportCreateRequest { /** @var ReportCreateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ReportCreateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -329,11 +319,11 @@ public function listInvalidProperties() if ($this->container['report_type'] === null) { $invalidProperties[] = "'report_type' can't be null"; } - if ((count($this->container['report_type']) > 2)) { + if (count($this->container['report_type']) > 2) { $invalidProperties[] = "invalid value for 'report_type', number of items must be less than or equal to 2."; } - if ((count($this->container['report_type']) < 1)) { + if (count($this->container['report_type']) < 1) { $invalidProperties[] = "invalid value for 'report_type', number of items must be greater than or equal to 1."; } @@ -354,7 +344,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets end_date * @@ -368,14 +357,14 @@ public function getEndDate() /** * Sets end_date * - * @param string $end_date The (inclusive) end date for the report data in `MM/DD/YYYY` format. + * @param string $end_date the (inclusive) end date for the report data in `MM/DD/YYYY` format * * @return self */ - public function setEndDate($end_date) + public function setEndDate(string $end_date) { if (is_null($end_date)) { - throw new \InvalidArgumentException('non-nullable end_date cannot be null'); + throw new InvalidArgumentException('non-nullable end_date cannot be null'); } $this->container['end_date'] = $end_date; @@ -399,14 +388,14 @@ public function getReportType() * * @return self */ - public function setReportType($report_type) + public function setReportType(array $report_type) { if (is_null($report_type)) { - throw new \InvalidArgumentException('non-nullable report_type cannot be null'); + throw new InvalidArgumentException('non-nullable report_type cannot be null'); } $allowedValues = $this->getReportTypeAllowableValues(); if (array_diff($report_type, $allowedValues)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value for 'report_type', must be one of '%s'", implode("', '", $allowedValues) @@ -414,11 +403,11 @@ public function setReportType($report_type) ); } - if ((count($report_type) > 2)) { - throw new \InvalidArgumentException('invalid value for $report_type when calling ReportCreateRequest., number of items must be less than or equal to 2.'); + if (count($report_type) > 2) { + throw new InvalidArgumentException('invalid value for $report_type when calling ReportCreateRequest., number of items must be less than or equal to 2.'); } - if ((count($report_type) < 1)) { - throw new \InvalidArgumentException('invalid length for $report_type when calling ReportCreateRequest., number of items must be greater than or equal to 1.'); + if (count($report_type) < 1) { + throw new InvalidArgumentException('invalid length for $report_type when calling ReportCreateRequest., number of items must be greater than or equal to 1.'); } $this->container['report_type'] = $report_type; @@ -438,27 +427,26 @@ public function getStartDate() /** * Sets start_date * - * @param string $start_date The (inclusive) start date for the report data in `MM/DD/YYYY` format. + * @param string $start_date the (inclusive) start date for the report data in `MM/DD/YYYY` format * * @return self */ - public function setStartDate($start_date) + public function setStartDate(string $start_date) { if (is_null($start_date)) { - throw new \InvalidArgumentException('non-nullable start_date cannot be null'); + throw new InvalidArgumentException('non-nullable start_date cannot be null'); } $this->container['start_date'] = $start_date; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -467,11 +455,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -482,10 +470,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -498,11 +484,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -510,15 +494,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -544,5 +528,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ReportCreateResponse.php b/sdks/php/src/Model/ReportCreateResponse.php index 33508edf2..415406e3c 100644 --- a/sdks/php/src/Model/ReportCreateResponse.php +++ b/sdks/php/src/Model/ReportCreateResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ReportCreateResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ReportCreateResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class ReportCreateResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ReportCreateResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'report' => '\Dropbox\Sign\Model\ReportResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'report' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'report' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'report' => 'report', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'report' => 'setReport', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'report' => 'getReport', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ReportCreateResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ReportCreateResponse { /** @var ReportCreateResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ReportCreateResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets report * - * @return \Dropbox\Sign\Model\ReportResponse + * @return ReportResponse */ public function getReport() { @@ -332,14 +320,14 @@ public function getReport() /** * Sets report * - * @param \Dropbox\Sign\Model\ReportResponse $report report + * @param ReportResponse $report report * * @return self */ - public function setReport($report) + public function setReport(ReportResponse $report) { if (is_null($report)) { - throw new \InvalidArgumentException('non-nullable report cannot be null'); + throw new InvalidArgumentException('non-nullable report cannot be null'); } $this->container['report'] = $report; @@ -349,7 +337,7 @@ public function setReport($report) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/ReportResponse.php b/sdks/php/src/Model/ReportResponse.php index 4b8c77cc7..c2d024ca1 100644 --- a/sdks/php/src/Model/ReportResponse.php +++ b/sdks/php/src/Model/ReportResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,73 +27,74 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * ReportResponse Class Doc Comment * * @category Class * @description Contains information about the report request. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class ReportResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class ReportResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'ReportResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'success' => 'string', 'start_date' => 'string', 'end_date' => 'string', - 'report_type' => 'string[]' + 'report_type' => 'string[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'success' => null, 'start_date' => null, 'end_date' => null, - 'report_type' => null + 'report_type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'success' => false, 'start_date' => false, 'end_date' => false, - 'report_type' => false + 'report_type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,8 +119,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -131,7 +128,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +138,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,9 +147,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -161,9 +155,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool 'success' => 'success', 'start_date' => 'start_date', 'end_date' => 'end_date', - 'report_type' => 'report_type' + 'report_type' => 'report_type', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'success' => 'setSuccess', 'start_date' => 'setStartDate', 'end_date' => 'setEndDate', - 'report_type' => 'setReportType' + 'report_type' => 'setReportType', ]; /** @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'success' => 'getSuccess', 'start_date' => 'getStartDate', 'end_date' => 'getEndDate', - 'report_type' => 'getReportType' + 'report_type' => 'getReportType', ]; /** @@ -285,34 +276,33 @@ public function __construct(array $data = null) $this->setIfExists('report_type', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): ReportResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): ReportResponse { /** @var ReportResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, ReportResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -329,9 +319,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -345,7 +333,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets success * @@ -363,10 +350,10 @@ public function getSuccess() * * @return self */ - public function setSuccess($success) + public function setSuccess(?string $success) { if (is_null($success)) { - throw new \InvalidArgumentException('non-nullable success cannot be null'); + throw new InvalidArgumentException('non-nullable success cannot be null'); } $this->container['success'] = $success; @@ -386,14 +373,14 @@ public function getStartDate() /** * Sets start_date * - * @param string|null $start_date The (inclusive) start date for the report data in MM/DD/YYYY format. + * @param string|null $start_date the (inclusive) start date for the report data in MM/DD/YYYY format * * @return self */ - public function setStartDate($start_date) + public function setStartDate(?string $start_date) { if (is_null($start_date)) { - throw new \InvalidArgumentException('non-nullable start_date cannot be null'); + throw new InvalidArgumentException('non-nullable start_date cannot be null'); } $this->container['start_date'] = $start_date; @@ -413,14 +400,14 @@ public function getEndDate() /** * Sets end_date * - * @param string|null $end_date The (inclusive) end date for the report data in MM/DD/YYYY format. + * @param string|null $end_date the (inclusive) end date for the report data in MM/DD/YYYY format * * @return self */ - public function setEndDate($end_date) + public function setEndDate(?string $end_date) { if (is_null($end_date)) { - throw new \InvalidArgumentException('non-nullable end_date cannot be null'); + throw new InvalidArgumentException('non-nullable end_date cannot be null'); } $this->container['end_date'] = $end_date; @@ -444,14 +431,14 @@ public function getReportType() * * @return self */ - public function setReportType($report_type) + public function setReportType(?array $report_type) { if (is_null($report_type)) { - throw new \InvalidArgumentException('non-nullable report_type cannot be null'); + throw new InvalidArgumentException('non-nullable report_type cannot be null'); } $allowedValues = $this->getReportTypeAllowableValues(); if (array_diff($report_type, $allowedValues)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value for 'report_type', must be one of '%s'", implode("', '", $allowedValues) @@ -462,14 +449,13 @@ public function setReportType($report_type) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -478,11 +464,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -493,10 +479,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -509,11 +493,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -521,15 +503,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -555,5 +537,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php index ff41695c0..9c5947fec 100644 --- a/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * SignatureRequestBulkCreateEmbeddedWithTemplateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestBulkCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestBulkCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestBulkCreateEmbeddedWithTemplateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_ids' => 'string[]', 'client_id' => 'string', @@ -70,16 +70,16 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest implements ModelInte 'signing_redirect_url' => 'string', 'subject' => 'string', 'test_mode' => 'bool', - 'title' => 'string' + 'title' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_ids' => null, 'client_id' => null, @@ -93,14 +93,14 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest implements ModelInte 'signing_redirect_url' => null, 'subject' => null, 'test_mode' => null, - 'title' => null + 'title' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'template_ids' => false, 'client_id' => false, @@ -114,14 +114,14 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest implements ModelInte 'signing_redirect_url' => false, 'subject' => false, 'test_mode' => false, - 'title' => false + 'title' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -146,8 +146,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -157,7 +155,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -167,7 +165,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -176,9 +174,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -187,9 +182,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -215,7 +207,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'signing_redirect_url', 'subject' => 'subject', 'test_mode' => 'test_mode', - 'title' => 'title' + 'title' => 'title', ]; /** @@ -236,7 +228,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'setSigningRedirectUrl', 'subject' => 'setSubject', 'test_mode' => 'setTestMode', - 'title' => 'setTitle' + 'title' => 'setTitle', ]; /** @@ -257,7 +249,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'getSigningRedirectUrl', 'subject' => 'getSubject', 'test_mode' => 'getTestMode', - 'title' => 'getTitle' + 'title' => 'getTitle', ]; /** @@ -301,7 +293,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -332,34 +323,33 @@ public function __construct(array $data = null) $this->setIfExists('title', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestBulkCreateEmbeddedWithTemplateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestBulkCreateEmbeddedWithTemplateRequest { /** @var SignatureRequestBulkCreateEmbeddedWithTemplateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestBulkCreateEmbeddedWithTemplateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -410,7 +400,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template_ids * @@ -424,14 +413,14 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[] $template_ids Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used * * @return self */ - public function setTemplateIds($template_ids) + public function setTemplateIds(array $template_ids) { if (is_null($template_ids)) { - throw new \InvalidArgumentException('non-nullable template_ids cannot be null'); + throw new InvalidArgumentException('non-nullable template_ids cannot be null'); } $this->container['template_ids'] = $template_ids; @@ -455,10 +444,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -468,7 +457,7 @@ public function setClientId($client_id) /** * Gets signer_file * - * @return \SplFileObject|null + * @return SplFileObject|null */ public function getSignerFile() { @@ -478,14 +467,14 @@ public function getSignerFile() /** * Sets signer_file * - * @param \SplFileObject|null $signer_file `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` + * @param SplFileObject|null $signer_file `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` * * @return self */ - public function setSignerFile($signer_file) + public function setSignerFile(?SplFileObject $signer_file) { if (is_null($signer_file)) { - throw new \InvalidArgumentException('non-nullable signer_file cannot be null'); + throw new InvalidArgumentException('non-nullable signer_file cannot be null'); } $this->container['signer_file'] = $signer_file; @@ -495,7 +484,7 @@ public function setSignerFile($signer_file) /** * Gets signer_list * - * @return \Dropbox\Sign\Model\SubBulkSignerList[]|null + * @return SubBulkSignerList[]|null */ public function getSignerList() { @@ -505,14 +494,14 @@ public function getSignerList() /** * Sets signer_list * - * @param \Dropbox\Sign\Model\SubBulkSignerList[]|null $signer_list `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. + * @param SubBulkSignerList[]|null $signer_list `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. * * @return self */ - public function setSignerList($signer_list) + public function setSignerList(?array $signer_list) { if (is_null($signer_list)) { - throw new \InvalidArgumentException('non-nullable signer_list cannot be null'); + throw new InvalidArgumentException('non-nullable signer_list cannot be null'); } $this->container['signer_list'] = $signer_list; @@ -536,10 +525,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline($allow_decline) + public function setAllowDecline(?bool $allow_decline) { if (is_null($allow_decline)) { - throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -549,7 +538,7 @@ public function setAllowDecline($allow_decline) /** * Gets ccs * - * @return \Dropbox\Sign\Model\SubCC[]|null + * @return SubCC[]|null */ public function getCcs() { @@ -559,14 +548,14 @@ public function getCcs() /** * Sets ccs * - * @param \Dropbox\Sign\Model\SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. * * @return self */ - public function setCcs($ccs) + public function setCcs(?array $ccs) { if (is_null($ccs)) { - throw new \InvalidArgumentException('non-nullable ccs cannot be null'); + throw new InvalidArgumentException('non-nullable ccs cannot be null'); } $this->container['ccs'] = $ccs; @@ -576,7 +565,7 @@ public function setCcs($ccs) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SubCustomField[]|null + * @return SubCustomField[]|null */ public function getCustomFields() { @@ -586,14 +575,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -613,17 +602,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that will be sent to the signers. + * @param string|null $message the custom message in the email that will be sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -648,13 +637,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -673,14 +661,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -700,17 +688,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that will be sent to the signers. + * @param string|null $subject the subject in the email that will be sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 255)) { - throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -735,10 +723,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -758,31 +746,30 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title you want to assign to the SignatureRequest. + * @param string|null $title the title you want to assign to the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } - if ((mb_strlen($title) > 255)) { - throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -791,11 +778,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -806,10 +793,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -822,11 +807,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -834,15 +817,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -868,5 +851,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php index 47c8ed8ee..26092eb3f 100644 --- a/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * SignatureRequestBulkSendWithTemplateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestBulkSendWithTemplateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestBulkSendWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestBulkSendWithTemplateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_ids' => 'string[]', 'signer_file' => '\SplFileObject', @@ -70,16 +70,16 @@ class SignatureRequestBulkSendWithTemplateRequest implements ModelInterface, Arr 'signing_redirect_url' => 'string', 'subject' => 'string', 'test_mode' => 'bool', - 'title' => 'string' + 'title' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_ids' => null, 'signer_file' => 'binary', @@ -93,14 +93,14 @@ class SignatureRequestBulkSendWithTemplateRequest implements ModelInterface, Arr 'signing_redirect_url' => null, 'subject' => null, 'test_mode' => null, - 'title' => null + 'title' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'template_ids' => false, 'signer_file' => false, @@ -114,14 +114,14 @@ class SignatureRequestBulkSendWithTemplateRequest implements ModelInterface, Arr 'signing_redirect_url' => false, 'subject' => false, 'test_mode' => false, - 'title' => false + 'title' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -146,8 +146,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -157,7 +155,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -167,7 +165,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -176,9 +174,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -187,9 +182,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -215,7 +207,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'signing_redirect_url', 'subject' => 'subject', 'test_mode' => 'test_mode', - 'title' => 'title' + 'title' => 'title', ]; /** @@ -236,7 +228,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'setSigningRedirectUrl', 'subject' => 'setSubject', 'test_mode' => 'setTestMode', - 'title' => 'setTitle' + 'title' => 'setTitle', ]; /** @@ -257,7 +249,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'getSigningRedirectUrl', 'subject' => 'getSubject', 'test_mode' => 'getTestMode', - 'title' => 'getTitle' + 'title' => 'getTitle', ]; /** @@ -301,7 +293,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -332,34 +323,33 @@ public function __construct(array $data = null) $this->setIfExists('title', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestBulkSendWithTemplateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestBulkSendWithTemplateRequest { /** @var SignatureRequestBulkSendWithTemplateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestBulkSendWithTemplateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -407,7 +397,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template_ids * @@ -421,14 +410,14 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[] $template_ids Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used * * @return self */ - public function setTemplateIds($template_ids) + public function setTemplateIds(array $template_ids) { if (is_null($template_ids)) { - throw new \InvalidArgumentException('non-nullable template_ids cannot be null'); + throw new InvalidArgumentException('non-nullable template_ids cannot be null'); } $this->container['template_ids'] = $template_ids; @@ -438,7 +427,7 @@ public function setTemplateIds($template_ids) /** * Gets signer_file * - * @return \SplFileObject|null + * @return SplFileObject|null */ public function getSignerFile() { @@ -448,14 +437,14 @@ public function getSignerFile() /** * Sets signer_file * - * @param \SplFileObject|null $signer_file `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` + * @param SplFileObject|null $signer_file `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` * * @return self */ - public function setSignerFile($signer_file) + public function setSignerFile(?SplFileObject $signer_file) { if (is_null($signer_file)) { - throw new \InvalidArgumentException('non-nullable signer_file cannot be null'); + throw new InvalidArgumentException('non-nullable signer_file cannot be null'); } $this->container['signer_file'] = $signer_file; @@ -465,7 +454,7 @@ public function setSignerFile($signer_file) /** * Gets signer_list * - * @return \Dropbox\Sign\Model\SubBulkSignerList[]|null + * @return SubBulkSignerList[]|null */ public function getSignerList() { @@ -475,14 +464,14 @@ public function getSignerList() /** * Sets signer_list * - * @param \Dropbox\Sign\Model\SubBulkSignerList[]|null $signer_list `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. + * @param SubBulkSignerList[]|null $signer_list `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. * * @return self */ - public function setSignerList($signer_list) + public function setSignerList(?array $signer_list) { if (is_null($signer_list)) { - throw new \InvalidArgumentException('non-nullable signer_list cannot be null'); + throw new InvalidArgumentException('non-nullable signer_list cannot be null'); } $this->container['signer_list'] = $signer_list; @@ -506,10 +495,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline($allow_decline) + public function setAllowDecline(?bool $allow_decline) { if (is_null($allow_decline)) { - throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -519,7 +508,7 @@ public function setAllowDecline($allow_decline) /** * Gets ccs * - * @return \Dropbox\Sign\Model\SubCC[]|null + * @return SubCC[]|null */ public function getCcs() { @@ -529,14 +518,14 @@ public function getCcs() /** * Sets ccs * - * @param \Dropbox\Sign\Model\SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. * * @return self */ - public function setCcs($ccs) + public function setCcs(?array $ccs) { if (is_null($ccs)) { - throw new \InvalidArgumentException('non-nullable ccs cannot be null'); + throw new InvalidArgumentException('non-nullable ccs cannot be null'); } $this->container['ccs'] = $ccs; @@ -560,10 +549,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(?string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -573,7 +562,7 @@ public function setClientId($client_id) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SubCustomField[]|null + * @return SubCustomField[]|null */ public function getCustomFields() { @@ -583,14 +572,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -610,17 +599,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that will be sent to the signers. + * @param string|null $message the custom message in the email that will be sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -645,13 +634,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -670,14 +658,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -697,17 +685,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that will be sent to the signers. + * @param string|null $subject the subject in the email that will be sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 255)) { - throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 255.'); + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -732,10 +720,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -755,31 +743,30 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title you want to assign to the SignatureRequest. + * @param string|null $title the title you want to assign to the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } - if ((mb_strlen($title) > 255)) { - throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 255.'); + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestBulkSendWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -788,11 +775,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -803,10 +790,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -819,11 +804,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -831,15 +814,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -865,5 +848,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php index 26262eb3e..7d14b823c 100644 --- a/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php +++ b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * SignatureRequestCreateEmbeddedRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestCreateEmbeddedRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'files' => '\SplFileObject[]', @@ -81,16 +81,16 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'title' => 'string', 'use_text_tags' => 'bool', 'populate_auto_fill_fields' => 'bool', - 'expires_at' => 'int' + 'expires_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'files' => 'binary', @@ -115,14 +115,14 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'title' => null, 'use_text_tags' => null, 'populate_auto_fill_fields' => null, - 'expires_at' => null + 'expires_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'files' => false, @@ -147,14 +147,14 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'title' => false, 'use_text_tags' => false, 'populate_auto_fill_fields' => false, - 'expires_at' => true + 'expires_at' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -179,8 +179,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -190,7 +188,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -200,7 +198,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -209,9 +207,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -220,9 +215,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -259,7 +251,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'title', 'use_text_tags' => 'use_text_tags', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', - 'expires_at' => 'expires_at' + 'expires_at' => 'expires_at', ]; /** @@ -291,7 +283,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', - 'expires_at' => 'setExpiresAt' + 'expires_at' => 'setExpiresAt', ]; /** @@ -323,7 +315,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', - 'expires_at' => 'getExpiresAt' + 'expires_at' => 'getExpiresAt', ]; /** @@ -367,7 +359,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -409,34 +400,33 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestCreateEmbeddedRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestCreateEmbeddedRequest { /** @var SignatureRequestCreateEmbeddedRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestCreateEmbeddedRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -484,7 +474,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets client_id * @@ -502,10 +491,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -515,7 +504,7 @@ public function setClientId($client_id) /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -525,14 +514,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -556,10 +545,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -569,7 +558,7 @@ public function setFileUrls($file_urls) /** * Gets signers * - * @return \Dropbox\Sign\Model\SubSignatureRequestSigner[]|null + * @return SubSignatureRequestSigner[]|null */ public function getSigners() { @@ -579,14 +568,14 @@ public function getSigners() /** * Sets signers * - * @param \Dropbox\Sign\Model\SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. * * @return self */ - public function setSigners($signers) + public function setSigners(?array $signers) { if (is_null($signers)) { - throw new \InvalidArgumentException('non-nullable signers cannot be null'); + throw new InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -596,7 +585,7 @@ public function setSigners($signers) /** * Gets grouped_signers * - * @return \Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]|null + * @return SubSignatureRequestGroupedSigners[]|null */ public function getGroupedSigners() { @@ -606,14 +595,14 @@ public function getGroupedSigners() /** * Sets grouped_signers * - * @param \Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. * * @return self */ - public function setGroupedSigners($grouped_signers) + public function setGroupedSigners(?array $grouped_signers) { if (is_null($grouped_signers)) { - throw new \InvalidArgumentException('non-nullable grouped_signers cannot be null'); + throw new InvalidArgumentException('non-nullable grouped_signers cannot be null'); } $this->container['grouped_signers'] = $grouped_signers; @@ -637,10 +626,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline($allow_decline) + public function setAllowDecline(?bool $allow_decline) { if (is_null($allow_decline)) { - throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -664,10 +653,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign($allow_reassign) + public function setAllowReassign(?bool $allow_reassign) { if (is_null($allow_reassign)) { - throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -677,7 +666,7 @@ public function setAllowReassign($allow_reassign) /** * Gets attachments * - * @return \Dropbox\Sign\Model\SubAttachment[]|null + * @return SubAttachment[]|null */ public function getAttachments() { @@ -687,14 +676,14 @@ public function getAttachments() /** * Sets attachments * - * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments($attachments) + public function setAttachments(?array $attachments) { if (is_null($attachments)) { - throw new \InvalidArgumentException('non-nullable attachments cannot be null'); + throw new InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -714,14 +703,14 @@ public function getCcEmailAddresses() /** * Sets cc_email_addresses * - * @param string[]|null $cc_email_addresses The email addresses that should be CCed. + * @param string[]|null $cc_email_addresses the email addresses that should be CCed * * @return self */ - public function setCcEmailAddresses($cc_email_addresses) + public function setCcEmailAddresses(?array $cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -731,7 +720,7 @@ public function setCcEmailAddresses($cc_email_addresses) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SubCustomField[]|null + * @return SubCustomField[]|null */ public function getCustomFields() { @@ -741,14 +730,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -758,7 +747,7 @@ public function setCustomFields($custom_fields) /** * Gets field_options * - * @return \Dropbox\Sign\Model\SubFieldOptions|null + * @return SubFieldOptions|null */ public function getFieldOptions() { @@ -768,14 +757,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options + * @param SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions($field_options) + public function setFieldOptions(?SubFieldOptions $field_options) { if (is_null($field_options)) { - throw new \InvalidArgumentException('non-nullable field_options cannot be null'); + throw new InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -785,7 +774,7 @@ public function setFieldOptions($field_options) /** * Gets form_field_groups * - * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null + * @return SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -795,14 +784,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups($form_field_groups) + public function setFormFieldGroups(?array $form_field_groups) { if (is_null($form_field_groups)) { - throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -812,7 +801,7 @@ public function setFormFieldGroups($form_field_groups) /** * Gets form_field_rules * - * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null + * @return SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -822,14 +811,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. + * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` * * @return self */ - public function setFormFieldRules($form_field_rules) + public function setFormFieldRules(?array $form_field_rules) { if (is_null($form_field_rules)) { - throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -839,7 +828,7 @@ public function setFormFieldRules($form_field_rules) /** * Gets form_fields_per_document * - * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null + * @return SubFormFieldsPerDocumentBase[]|null */ public function getFormFieldsPerDocument() { @@ -849,14 +838,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument($form_fields_per_document) + public function setFormFieldsPerDocument(?array $form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -880,10 +869,10 @@ public function getHideTextTags() * * @return self */ - public function setHideTextTags($hide_text_tags) + public function setHideTextTags(?bool $hide_text_tags) { if (is_null($hide_text_tags)) { - throw new \InvalidArgumentException('non-nullable hide_text_tags cannot be null'); + throw new InvalidArgumentException('non-nullable hide_text_tags cannot be null'); } $this->container['hide_text_tags'] = $hide_text_tags; @@ -903,17 +892,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that will be sent to the signers. + * @param string|null $message the custom message in the email that will be sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -938,13 +927,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -953,7 +941,7 @@ public function setMetadata($metadata) /** * Gets signing_options * - * @return \Dropbox\Sign\Model\SubSigningOptions|null + * @return SubSigningOptions|null */ public function getSigningOptions() { @@ -963,14 +951,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options + * @param SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions($signing_options) + public function setSigningOptions(?SubSigningOptions $signing_options) { if (is_null($signing_options)) { - throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -990,17 +978,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that will be sent to the signers. + * @param string|null $subject the subject in the email that will be sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 255)) { - throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 255.'); + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -1025,10 +1013,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1048,17 +1036,17 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title you want to assign to the SignatureRequest. + * @param string|null $title the title you want to assign to the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } - if ((mb_strlen($title) > 255)) { - throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 255.'); + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestCreateEmbeddedRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; @@ -1083,10 +1071,10 @@ public function getUseTextTags() * * @return self */ - public function setUseTextTags($use_text_tags) + public function setUseTextTags(?bool $use_text_tags) { if (is_null($use_text_tags)) { - throw new \InvalidArgumentException('non-nullable use_text_tags cannot be null'); + throw new InvalidArgumentException('non-nullable use_text_tags cannot be null'); } $this->container['use_text_tags'] = $use_text_tags; @@ -1110,10 +1098,10 @@ public function getPopulateAutoFillFields() * * @return self */ - public function setPopulateAutoFillFields($populate_auto_fill_fields) + public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) { if (is_null($populate_auto_fill_fields)) { - throw new \InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); + throw new InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); } $this->container['populate_auto_fill_fields'] = $populate_auto_fill_fields; @@ -1137,14 +1125,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1153,14 +1141,13 @@ public function setExpiresAt($expires_at) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1169,11 +1156,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1184,10 +1171,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1200,11 +1185,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1212,15 +1195,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1246,5 +1229,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php index ac4b8551d..b98f7b8b7 100644 --- a/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * SignatureRequestCreateEmbeddedWithTemplateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestCreateEmbeddedWithTemplateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_ids' => 'string[]', 'client_id' => 'string', @@ -72,16 +72,16 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac 'subject' => 'string', 'test_mode' => 'bool', 'title' => 'string', - 'populate_auto_fill_fields' => 'bool' + 'populate_auto_fill_fields' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_ids' => null, 'client_id' => null, @@ -97,14 +97,14 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac 'subject' => null, 'test_mode' => null, 'title' => null, - 'populate_auto_fill_fields' => null + 'populate_auto_fill_fields' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'template_ids' => false, 'client_id' => false, @@ -120,14 +120,14 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac 'subject' => false, 'test_mode' => false, 'title' => false, - 'populate_auto_fill_fields' => false + 'populate_auto_fill_fields' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -152,8 +152,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -163,7 +161,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -173,7 +171,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -182,9 +180,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -193,9 +188,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -223,7 +215,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'subject', 'test_mode' => 'test_mode', 'title' => 'title', - 'populate_auto_fill_fields' => 'populate_auto_fill_fields' + 'populate_auto_fill_fields' => 'populate_auto_fill_fields', ]; /** @@ -246,7 +238,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'setSubject', 'test_mode' => 'setTestMode', 'title' => 'setTitle', - 'populate_auto_fill_fields' => 'setPopulateAutoFillFields' + 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', ]; /** @@ -269,7 +261,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'getSubject', 'test_mode' => 'getTestMode', 'title' => 'getTitle', - 'populate_auto_fill_fields' => 'getPopulateAutoFillFields' + 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', ]; /** @@ -313,7 +305,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -346,34 +337,33 @@ public function __construct(array $data = null) $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestCreateEmbeddedWithTemplateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestCreateEmbeddedWithTemplateRequest { /** @var SignatureRequestCreateEmbeddedWithTemplateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestCreateEmbeddedWithTemplateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -427,7 +417,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template_ids * @@ -441,14 +430,14 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[] $template_ids Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used * * @return self */ - public function setTemplateIds($template_ids) + public function setTemplateIds(array $template_ids) { if (is_null($template_ids)) { - throw new \InvalidArgumentException('non-nullable template_ids cannot be null'); + throw new InvalidArgumentException('non-nullable template_ids cannot be null'); } $this->container['template_ids'] = $template_ids; @@ -472,10 +461,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -485,7 +474,7 @@ public function setClientId($client_id) /** * Gets signers * - * @return \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[] + * @return SubSignatureRequestTemplateSigner[] */ public function getSigners() { @@ -495,14 +484,14 @@ public function getSigners() /** * Sets signers * - * @param \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[] $signers Add Signers to your Templated-based Signature Request. + * @param SubSignatureRequestTemplateSigner[] $signers add Signers to your Templated-based Signature Request * * @return self */ - public function setSigners($signers) + public function setSigners(array $signers) { if (is_null($signers)) { - throw new \InvalidArgumentException('non-nullable signers cannot be null'); + throw new InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -526,10 +515,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline($allow_decline) + public function setAllowDecline(?bool $allow_decline) { if (is_null($allow_decline)) { - throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -539,7 +528,7 @@ public function setAllowDecline($allow_decline) /** * Gets ccs * - * @return \Dropbox\Sign\Model\SubCC[]|null + * @return SubCC[]|null */ public function getCcs() { @@ -549,14 +538,14 @@ public function getCcs() /** * Sets ccs * - * @param \Dropbox\Sign\Model\SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. * * @return self */ - public function setCcs($ccs) + public function setCcs(?array $ccs) { if (is_null($ccs)) { - throw new \InvalidArgumentException('non-nullable ccs cannot be null'); + throw new InvalidArgumentException('non-nullable ccs cannot be null'); } $this->container['ccs'] = $ccs; @@ -566,7 +555,7 @@ public function setCcs($ccs) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SubCustomField[]|null + * @return SubCustomField[]|null */ public function getCustomFields() { @@ -576,14 +565,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. + * @param SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -593,7 +582,7 @@ public function setCustomFields($custom_fields) /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -603,14 +592,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -634,10 +623,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -657,17 +646,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that will be sent to the signers. + * @param string|null $message the custom message in the email that will be sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -692,13 +681,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -707,7 +695,7 @@ public function setMetadata($metadata) /** * Gets signing_options * - * @return \Dropbox\Sign\Model\SubSigningOptions|null + * @return SubSigningOptions|null */ public function getSigningOptions() { @@ -717,14 +705,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options + * @param SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions($signing_options) + public function setSigningOptions(?SubSigningOptions $signing_options) { if (is_null($signing_options)) { - throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -744,17 +732,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that will be sent to the signers. + * @param string|null $subject the subject in the email that will be sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 255)) { - throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -779,10 +767,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -802,17 +790,17 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title you want to assign to the SignatureRequest. + * @param string|null $title the title you want to assign to the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } - if ((mb_strlen($title) > 255)) { - throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; @@ -837,23 +825,22 @@ public function getPopulateAutoFillFields() * * @return self */ - public function setPopulateAutoFillFields($populate_auto_fill_fields) + public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) { if (is_null($populate_auto_fill_fields)) { - throw new \InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); + throw new InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); } $this->container['populate_auto_fill_fields'] = $populate_auto_fill_fields; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -862,11 +849,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -877,10 +864,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -893,11 +878,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -905,15 +888,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -939,5 +922,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestGetResponse.php b/sdks/php/src/Model/SignatureRequestGetResponse.php index 8ea17ddd5..97f5f7c9f 100644 --- a/sdks/php/src/Model/SignatureRequestGetResponse.php +++ b/sdks/php/src/Model/SignatureRequestGetResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SignatureRequestGetResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestGetResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'signature_request' => '\Dropbox\Sign\Model\SignatureRequestResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'signature_request' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'signature_request' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'signature_request' => 'signature_request', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'signature_request' => 'setSignatureRequest', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'signature_request' => 'getSignatureRequest', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestGetResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestGetResponse { /** @var SignatureRequestGetResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestGetResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets signature_request * - * @return \Dropbox\Sign\Model\SignatureRequestResponse + * @return SignatureRequestResponse */ public function getSignatureRequest() { @@ -332,14 +320,14 @@ public function getSignatureRequest() /** * Sets signature_request * - * @param \Dropbox\Sign\Model\SignatureRequestResponse $signature_request signature_request + * @param SignatureRequestResponse $signature_request signature_request * * @return self */ - public function setSignatureRequest($signature_request) + public function setSignatureRequest(SignatureRequestResponse $signature_request) { if (is_null($signature_request)) { - throw new \InvalidArgumentException('non-nullable signature_request cannot be null'); + throw new InvalidArgumentException('non-nullable signature_request cannot be null'); } $this->container['signature_request'] = $signature_request; @@ -349,7 +337,7 @@ public function setSignatureRequest($signature_request) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestListResponse.php b/sdks/php/src/Model/SignatureRequestListResponse.php index 45af0d46b..659908071 100644 --- a/sdks/php/src/Model/SignatureRequestListResponse.php +++ b/sdks/php/src/Model/SignatureRequestListResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SignatureRequestListResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestListResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestListResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'signature_requests' => '\Dropbox\Sign\Model\SignatureRequestResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'signature_requests' => null, 'list_info' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'signature_requests' => false, 'list_info' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'signature_requests' => 'signature_requests', 'list_info' => 'list_info', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'signature_requests' => 'setSignatureRequests', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'signature_requests' => 'getSignatureRequests', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestListResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestListResponse { /** @var SignatureRequestListResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestListResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,11 +317,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets signature_requests * - * @return \Dropbox\Sign\Model\SignatureRequestResponse[] + * @return SignatureRequestResponse[] */ public function getSignatureRequests() { @@ -342,14 +330,14 @@ public function getSignatureRequests() /** * Sets signature_requests * - * @param \Dropbox\Sign\Model\SignatureRequestResponse[] $signature_requests Contains information about signature requests. + * @param SignatureRequestResponse[] $signature_requests contains information about signature requests * * @return self */ - public function setSignatureRequests($signature_requests) + public function setSignatureRequests(array $signature_requests) { if (is_null($signature_requests)) { - throw new \InvalidArgumentException('non-nullable signature_requests cannot be null'); + throw new InvalidArgumentException('non-nullable signature_requests cannot be null'); } $this->container['signature_requests'] = $signature_requests; @@ -359,7 +347,7 @@ public function setSignatureRequests($signature_requests) /** * Gets list_info * - * @return \Dropbox\Sign\Model\ListInfoResponse + * @return ListInfoResponse */ public function getListInfo() { @@ -369,14 +357,14 @@ public function getListInfo() /** * Sets list_info * - * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info + * @param ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo($list_info) + public function setListInfo(ListInfoResponse $list_info) { if (is_null($list_info)) { - throw new \InvalidArgumentException('non-nullable list_info cannot be null'); + throw new InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -386,7 +374,7 @@ public function setListInfo($list_info) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -396,27 +384,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -425,11 +412,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -440,10 +427,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -456,11 +441,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -468,15 +451,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -502,5 +485,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestRemindRequest.php b/sdks/php/src/Model/SignatureRequestRemindRequest.php index 0e5e350ee..5662351ef 100644 --- a/sdks/php/src/Model/SignatureRequestRemindRequest.php +++ b/sdks/php/src/Model/SignatureRequestRemindRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SignatureRequestRemindRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestRemindRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestRemindRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestRemindRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'email_address' => 'string', - 'name' => 'string' + 'name' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'email_address' => 'email', - 'name' => null + 'name' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'email_address' => false, - 'name' => false + 'name' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'email_address' => 'email_address', - 'name' => 'name' + 'name' => 'name', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'email_address' => 'setEmailAddress', - 'name' => 'setName' + 'name' => 'setName', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'email_address' => 'getEmailAddress', - 'name' => 'getName' + 'name' => 'getName', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestRemindRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestRemindRequest { /** @var SignatureRequestRemindRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestRemindRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,7 +307,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets email_address * @@ -332,14 +320,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address The email address of the signer to send a reminder to. + * @param string $email_address the email address of the signer to send a reminder to * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -363,23 +351,22 @@ public function getName() * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponse.php b/sdks/php/src/Model/SignatureRequestResponse.php index 254d3c2f9..08442f436 100644 --- a/sdks/php/src/Model/SignatureRequestResponse.php +++ b/sdks/php/src/Model/SignatureRequestResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SignatureRequestResponse Class Doc Comment * * @category Class * @description Contains information about a signature request. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'test_mode' => 'bool', 'signature_request_id' => 'string', @@ -83,16 +82,16 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, \JsonSeri 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', 'response_data' => '\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]', 'signatures' => '\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]', - 'bulk_send_job_id' => 'string' + 'bulk_send_job_id' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'test_mode' => null, 'signature_request_id' => null, @@ -118,14 +117,14 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, \JsonSeri 'attachments' => null, 'response_data' => null, 'signatures' => null, - 'bulk_send_job_id' => null + 'bulk_send_job_id' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'test_mode' => false, 'signature_request_id' => false, @@ -151,14 +150,14 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, \JsonSeri 'attachments' => true, 'response_data' => true, 'signatures' => false, - 'bulk_send_job_id' => true + 'bulk_send_job_id' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -183,8 +182,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -194,7 +191,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -204,7 +201,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -213,9 +210,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -224,9 +218,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -264,7 +255,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'attachments', 'response_data' => 'response_data', 'signatures' => 'signatures', - 'bulk_send_job_id' => 'bulk_send_job_id' + 'bulk_send_job_id' => 'bulk_send_job_id', ]; /** @@ -297,7 +288,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'setAttachments', 'response_data' => 'setResponseData', 'signatures' => 'setSignatures', - 'bulk_send_job_id' => 'setBulkSendJobId' + 'bulk_send_job_id' => 'setBulkSendJobId', ]; /** @@ -330,7 +321,7 @@ public function isNullableSetToNull(string $property): bool 'attachments' => 'getAttachments', 'response_data' => 'getResponseData', 'signatures' => 'getSignatures', - 'bulk_send_job_id' => 'getBulkSendJobId' + 'bulk_send_job_id' => 'getBulkSendJobId', ]; /** @@ -374,7 +365,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -417,34 +407,33 @@ public function __construct(array $data = null) $this->setIfExists('bulk_send_job_id', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponse { /** @var SignatureRequestResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -461,9 +450,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -477,7 +464,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets test_mode * @@ -495,10 +481,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -518,14 +504,14 @@ public function getSignatureRequestId() /** * Sets signature_request_id * - * @param string|null $signature_request_id The id of the SignatureRequest. + * @param string|null $signature_request_id the id of the SignatureRequest * * @return self */ - public function setSignatureRequestId($signature_request_id) + public function setSignatureRequestId(?string $signature_request_id) { if (is_null($signature_request_id)) { - throw new \InvalidArgumentException('non-nullable signature_request_id cannot be null'); + throw new InvalidArgumentException('non-nullable signature_request_id cannot be null'); } $this->container['signature_request_id'] = $signature_request_id; @@ -545,18 +531,18 @@ public function getRequesterEmailAddress() /** * Sets requester_email_address * - * @param string|null $requester_email_address The email address of the initiator of the SignatureRequest. + * @param string|null $requester_email_address the email address of the initiator of the SignatureRequest * * @return self */ - public function setRequesterEmailAddress($requester_email_address) + public function setRequesterEmailAddress(?string $requester_email_address) { if (is_null($requester_email_address)) { array_push($this->openAPINullablesSetToNull, 'requester_email_address'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('requester_email_address', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -579,14 +565,14 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title the specified Account uses for the SignatureRequest. + * @param string|null $title the title the specified Account uses for the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -606,14 +592,14 @@ public function getOriginalTitle() /** * Sets original_title * - * @param string|null $original_title Default Label for account. + * @param string|null $original_title default Label for account * * @return self */ - public function setOriginalTitle($original_title) + public function setOriginalTitle(?string $original_title) { if (is_null($original_title)) { - throw new \InvalidArgumentException('non-nullable original_title cannot be null'); + throw new InvalidArgumentException('non-nullable original_title cannot be null'); } $this->container['original_title'] = $original_title; @@ -633,18 +619,18 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that was initially sent to the signers. + * @param string|null $subject the subject in the email that was initially sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { array_push($this->openAPINullablesSetToNull, 'subject'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('subject', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -667,18 +653,18 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that was initially sent to the signers. + * @param string|null $message the custom message in the email that was initially sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { array_push($this->openAPINullablesSetToNull, 'message'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('message', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -701,14 +687,14 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata The metadata attached to the signature request. + * @param array|null $metadata the metadata attached to the signature request * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } $this->container['metadata'] = $metadata; @@ -728,14 +714,14 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at Time the signature request was created. + * @param int|null $created_at time the signature request was created * * @return self */ - public function setCreatedAt($created_at) + public function setCreatedAt(?int $created_at) { if (is_null($created_at)) { - throw new \InvalidArgumentException('non-nullable created_at cannot be null'); + throw new InvalidArgumentException('non-nullable created_at cannot be null'); } $this->container['created_at'] = $created_at; @@ -759,14 +745,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -789,14 +775,14 @@ public function getIsComplete() /** * Sets is_complete * - * @param bool|null $is_complete Whether or not the SignatureRequest has been fully executed by all signers. + * @param bool|null $is_complete whether or not the SignatureRequest has been fully executed by all signers * * @return self */ - public function setIsComplete($is_complete) + public function setIsComplete(?bool $is_complete) { if (is_null($is_complete)) { - throw new \InvalidArgumentException('non-nullable is_complete cannot be null'); + throw new InvalidArgumentException('non-nullable is_complete cannot be null'); } $this->container['is_complete'] = $is_complete; @@ -816,14 +802,14 @@ public function getIsDeclined() /** * Sets is_declined * - * @param bool|null $is_declined Whether or not the SignatureRequest has been declined by a signer. + * @param bool|null $is_declined whether or not the SignatureRequest has been declined by a signer * * @return self */ - public function setIsDeclined($is_declined) + public function setIsDeclined(?bool $is_declined) { if (is_null($is_declined)) { - throw new \InvalidArgumentException('non-nullable is_declined cannot be null'); + throw new InvalidArgumentException('non-nullable is_declined cannot be null'); } $this->container['is_declined'] = $is_declined; @@ -843,14 +829,14 @@ public function getHasError() /** * Sets has_error * - * @param bool|null $has_error Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + * @param bool|null $has_error whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings) * * @return self */ - public function setHasError($has_error) + public function setHasError(?bool $has_error) { if (is_null($has_error)) { - throw new \InvalidArgumentException('non-nullable has_error cannot be null'); + throw new InvalidArgumentException('non-nullable has_error cannot be null'); } $this->container['has_error'] = $has_error; @@ -870,14 +856,14 @@ public function getFilesUrl() /** * Sets files_url * - * @param string|null $files_url The URL where a copy of the request's documents can be downloaded. + * @param string|null $files_url the URL where a copy of the request's documents can be downloaded * * @return self */ - public function setFilesUrl($files_url) + public function setFilesUrl(?string $files_url) { if (is_null($files_url)) { - throw new \InvalidArgumentException('non-nullable files_url cannot be null'); + throw new InvalidArgumentException('non-nullable files_url cannot be null'); } $this->container['files_url'] = $files_url; @@ -901,14 +887,14 @@ public function getSigningUrl() * * @return self */ - public function setSigningUrl($signing_url) + public function setSigningUrl(?string $signing_url) { if (is_null($signing_url)) { array_push($this->openAPINullablesSetToNull, 'signing_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signing_url', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -931,14 +917,14 @@ public function getDetailsUrl() /** * Sets details_url * - * @param string|null $details_url The URL where the requester and the signers can view the current status of the SignatureRequest. + * @param string|null $details_url the URL where the requester and the signers can view the current status of the SignatureRequest * * @return self */ - public function setDetailsUrl($details_url) + public function setDetailsUrl(?string $details_url) { if (is_null($details_url)) { - throw new \InvalidArgumentException('non-nullable details_url cannot be null'); + throw new InvalidArgumentException('non-nullable details_url cannot be null'); } $this->container['details_url'] = $details_url; @@ -962,10 +948,10 @@ public function getCcEmailAddresses() * * @return self */ - public function setCcEmailAddresses($cc_email_addresses) + public function setCcEmailAddresses(?array $cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -985,18 +971,18 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want the signer redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want the signer redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { array_push($this->openAPINullablesSetToNull, 'signing_redirect_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signing_redirect_url', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1023,14 +1009,14 @@ public function getFinalCopyUri() * * @return self */ - public function setFinalCopyUri($final_copy_uri) + public function setFinalCopyUri(?string $final_copy_uri) { if (is_null($final_copy_uri)) { array_push($this->openAPINullablesSetToNull, 'final_copy_uri'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('final_copy_uri', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1053,18 +1039,18 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[]|null $template_ids Templates IDs used in this SignatureRequest (if any). + * @param string[]|null $template_ids templates IDs used in this SignatureRequest (if any) * * @return self */ - public function setTemplateIds($template_ids) + public function setTemplateIds(?array $template_ids) { if (is_null($template_ids)) { array_push($this->openAPINullablesSetToNull, 'template_ids'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('template_ids', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1077,7 +1063,7 @@ public function setTemplateIds($template_ids) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]|null + * @return SignatureRequestResponseCustomFieldBase[]|null */ public function getCustomFields() { @@ -1087,18 +1073,18 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]|null $custom_fields An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * @param SignatureRequestResponseCustomFieldBase[]|null $custom_fields An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { array_push($this->openAPINullablesSetToNull, 'custom_fields'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('custom_fields', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1111,7 +1097,7 @@ public function setCustomFields($custom_fields) /** * Gets attachments * - * @return \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null + * @return SignatureRequestResponseAttachment[]|null */ public function getAttachments() { @@ -1121,18 +1107,18 @@ public function getAttachments() /** * Sets attachments * - * @param \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null $attachments Signer attachments. + * @param SignatureRequestResponseAttachment[]|null $attachments signer attachments * * @return self */ - public function setAttachments($attachments) + public function setAttachments(?array $attachments) { if (is_null($attachments)) { array_push($this->openAPINullablesSetToNull, 'attachments'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('attachments', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1145,7 +1131,7 @@ public function setAttachments($attachments) /** * Gets response_data * - * @return \Dropbox\Sign\Model\SignatureRequestResponseDataBase[]|null + * @return SignatureRequestResponseDataBase[]|null */ public function getResponseData() { @@ -1155,18 +1141,18 @@ public function getResponseData() /** * Sets response_data * - * @param \Dropbox\Sign\Model\SignatureRequestResponseDataBase[]|null $response_data An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + * @param SignatureRequestResponseDataBase[]|null $response_data an array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers * * @return self */ - public function setResponseData($response_data) + public function setResponseData(?array $response_data) { if (is_null($response_data)) { array_push($this->openAPINullablesSetToNull, 'response_data'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('response_data', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1179,7 +1165,7 @@ public function setResponseData($response_data) /** * Gets signatures * - * @return \Dropbox\Sign\Model\SignatureRequestResponseSignatures[]|null + * @return SignatureRequestResponseSignatures[]|null */ public function getSignatures() { @@ -1189,14 +1175,14 @@ public function getSignatures() /** * Sets signatures * - * @param \Dropbox\Sign\Model\SignatureRequestResponseSignatures[]|null $signatures An array of signature objects, 1 for each signer. + * @param SignatureRequestResponseSignatures[]|null $signatures an array of signature objects, 1 for each signer * * @return self */ - public function setSignatures($signatures) + public function setSignatures(?array $signatures) { if (is_null($signatures)) { - throw new \InvalidArgumentException('non-nullable signatures cannot be null'); + throw new InvalidArgumentException('non-nullable signatures cannot be null'); } $this->container['signatures'] = $signatures; @@ -1216,18 +1202,18 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string|null $bulk_send_job_id The ID of the Bulk Send job which sent the signature request, if applicable. + * @param string|null $bulk_send_job_id the ID of the Bulk Send job which sent the signature request, if applicable * * @return self */ - public function setBulkSendJobId($bulk_send_job_id) + public function setBulkSendJobId(?string $bulk_send_job_id) { if (is_null($bulk_send_job_id)) { array_push($this->openAPINullablesSetToNull, 'bulk_send_job_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('bulk_send_job_id', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1236,14 +1222,13 @@ public function setBulkSendJobId($bulk_send_job_id) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1252,11 +1237,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1267,10 +1252,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1283,11 +1266,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1295,15 +1276,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1329,5 +1310,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseAttachment.php b/sdks/php/src/Model/SignatureRequestResponseAttachment.php index 7c38b92f0..245930a52 100644 --- a/sdks/php/src/Model/SignatureRequestResponseAttachment.php +++ b/sdks/php/src/Model/SignatureRequestResponseAttachment.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,79 +27,80 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SignatureRequestResponseAttachment Class Doc Comment * * @category Class * @description Signer attachments. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestResponseAttachment implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestResponseAttachment implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseAttachment'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'id' => 'string', 'signer' => 'string', 'name' => 'string', 'required' => 'bool', 'instructions' => 'string', - 'uploaded_at' => 'int' + 'uploaded_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'id' => null, 'signer' => null, 'name' => null, 'required' => null, 'instructions' => null, - 'uploaded_at' => null + 'uploaded_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'id' => false, 'signer' => false, 'name' => false, 'required' => false, 'instructions' => true, - 'uploaded_at' => true + 'uploaded_at' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -126,8 +125,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -137,7 +134,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -147,7 +144,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -156,9 +153,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -167,9 +161,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -188,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'required' => 'required', 'instructions' => 'instructions', - 'uploaded_at' => 'uploaded_at' + 'uploaded_at' => 'uploaded_at', ]; /** @@ -202,7 +193,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'required' => 'setRequired', 'instructions' => 'setInstructions', - 'uploaded_at' => 'setUploadedAt' + 'uploaded_at' => 'setUploadedAt', ]; /** @@ -216,7 +207,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'required' => 'getRequired', 'instructions' => 'getInstructions', - 'uploaded_at' => 'getUploadedAt' + 'uploaded_at' => 'getUploadedAt', ]; /** @@ -260,7 +251,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -284,34 +274,33 @@ public function __construct(array $data = null) $this->setIfExists('uploaded_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseAttachment { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseAttachment { /** @var SignatureRequestResponseAttachment */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseAttachment::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -356,7 +345,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets id * @@ -370,14 +358,14 @@ public function getId() /** * Sets id * - * @param string $id The unique ID for this attachment. + * @param string $id the unique ID for this attachment * * @return self */ - public function setId($id) + public function setId(string $id) { if (is_null($id)) { - throw new \InvalidArgumentException('non-nullable id cannot be null'); + throw new InvalidArgumentException('non-nullable id cannot be null'); } $this->container['id'] = $id; @@ -397,14 +385,14 @@ public function getSigner() /** * Sets signer * - * @param string $signer The Signer this attachment is assigned to. + * @param string $signer the Signer this attachment is assigned to * * @return self */ - public function setSigner($signer) + public function setSigner(string $signer) { if (is_null($signer)) { - throw new \InvalidArgumentException('non-nullable signer cannot be null'); + throw new InvalidArgumentException('non-nullable signer cannot be null'); } $this->container['signer'] = $signer; @@ -424,14 +412,14 @@ public function getName() /** * Sets name * - * @param string $name The name of this attachment. + * @param string $name the name of this attachment * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -451,14 +439,14 @@ public function getRequired() /** * Sets required * - * @param bool $required A boolean value denoting if this attachment is required. + * @param bool $required a boolean value denoting if this attachment is required * * @return self */ - public function setRequired($required) + public function setRequired(bool $required) { if (is_null($required)) { - throw new \InvalidArgumentException('non-nullable required cannot be null'); + throw new InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -478,18 +466,18 @@ public function getInstructions() /** * Sets instructions * - * @param string|null $instructions Instructions for Signer. + * @param string|null $instructions instructions for Signer * * @return self */ - public function setInstructions($instructions) + public function setInstructions(?string $instructions) { if (is_null($instructions)) { array_push($this->openAPINullablesSetToNull, 'instructions'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('instructions', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -512,18 +500,18 @@ public function getUploadedAt() /** * Sets uploaded_at * - * @param int|null $uploaded_at Timestamp when attachment was uploaded by Signer. + * @param int|null $uploaded_at timestamp when attachment was uploaded by Signer * * @return self */ - public function setUploadedAt($uploaded_at) + public function setUploadedAt(?int $uploaded_at) { if (is_null($uploaded_at)) { array_push($this->openAPINullablesSetToNull, 'uploaded_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('uploaded_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -532,14 +520,13 @@ public function setUploadedAt($uploaded_at) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -548,11 +535,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -563,10 +550,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -579,11 +564,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -591,15 +574,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -625,5 +608,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php index 2d2fdeac0..bfa753e11 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,76 +27,77 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SignatureRequestResponseCustomFieldBase Class Doc Comment * * @category Class * @description An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestResponseCustomFieldBase implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestResponseCustomFieldBase implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseCustomFieldBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'name' => 'string', 'required' => 'bool', 'api_id' => 'string', - 'editor' => 'string' + 'editor' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'name' => null, 'required' => null, 'api_id' => null, - 'editor' => null + 'editor' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'name' => false, 'required' => false, 'api_id' => false, - 'editor' => true + 'editor' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -123,8 +122,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -134,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -144,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -153,9 +150,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -164,9 +158,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'required' => 'required', 'api_id' => 'api_id', - 'editor' => 'editor' + 'editor' => 'editor', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'required' => 'setRequired', 'api_id' => 'setApiId', - 'editor' => 'setEditor' + 'editor' => 'setEditor', ]; /** @@ -210,7 +201,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'required' => 'getRequired', 'api_id' => 'getApiId', - 'editor' => 'getEditor' + 'editor' => 'getEditor', ]; /** @@ -254,7 +245,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -280,7 +270,6 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } - public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -298,14 +287,12 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -344,7 +331,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -362,10 +348,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -385,14 +371,14 @@ public function getName() /** * Sets name * - * @param string $name The name of the Custom Field. + * @param string $name the name of the Custom Field * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -412,14 +398,14 @@ public function getRequired() /** * Sets required * - * @param bool|null $required A boolean value denoting if this field is required. + * @param bool|null $required a boolean value denoting if this field is required * * @return self */ - public function setRequired($required) + public function setRequired(?bool $required) { if (is_null($required)) { - throw new \InvalidArgumentException('non-nullable required cannot be null'); + throw new InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -439,14 +425,14 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id The unique ID for this field. + * @param string|null $api_id the unique ID for this field * * @return self */ - public function setApiId($api_id) + public function setApiId(?string $api_id) { if (is_null($api_id)) { - throw new \InvalidArgumentException('non-nullable api_id cannot be null'); + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -466,18 +452,18 @@ public function getEditor() /** * Sets editor * - * @param string|null $editor The name of the Role that is able to edit this field. + * @param string|null $editor the name of the Role that is able to edit this field * * @return self */ - public function setEditor($editor) + public function setEditor(?string $editor) { if (is_null($editor)) { array_push($this->openAPINullablesSetToNull, 'editor'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('editor', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -486,14 +472,13 @@ public function setEditor($editor) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -502,11 +487,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -517,10 +502,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -533,11 +516,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -545,15 +526,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -579,5 +560,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php index eef89e32f..d16c804e7 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseCustomFieldCheckbox Class Doc Comment * * @category Class * @description This class extends `SignatureRequestResponseCustomFieldBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseCustomFieldCheckbox extends SignatureRequestResponseCustomFieldBase @@ -45,49 +44,49 @@ class SignatureRequestResponseCustomFieldCheckbox extends SignatureRequestRespon public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseCustomFieldCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'bool' + 'value' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,8 +111,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -123,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,9 +139,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -153,9 +147,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -190,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -234,8 +225,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -250,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseCustomFieldCheckbox { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseCustomFieldCheckbox { /** @var SignatureRequestResponseCustomFieldCheckbox */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseCustomFieldCheckbox::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -313,7 +301,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -331,10 +318,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -358,23 +345,22 @@ public function getValue() * * @return self */ - public function setValue($value) + public function setValue(?bool $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -383,11 +369,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -398,10 +384,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -414,11 +398,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -426,15 +408,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -460,5 +442,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php index 62a23a317..4115fc171 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseCustomFieldText Class Doc Comment * * @category Class * @description This class extends `SignatureRequestResponseCustomFieldBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseCustomFieldText extends SignatureRequestResponseCustomFieldBase @@ -45,49 +44,49 @@ class SignatureRequestResponseCustomFieldText extends SignatureRequestResponseCu public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseCustomFieldText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string' + 'value' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,8 +111,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -123,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,9 +139,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -153,9 +147,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -190,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -234,8 +225,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -250,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseCustomFieldText { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseCustomFieldText { /** @var SignatureRequestResponseCustomFieldText */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseCustomFieldText::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -313,7 +301,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -331,10 +318,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -358,23 +345,22 @@ public function getValue() * * @return self */ - public function setValue($value) + public function setValue(?string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -383,11 +369,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -398,10 +384,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -414,11 +398,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -426,15 +408,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -460,5 +442,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldTypeEnum.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldTypeEnum.php index d00c3cffb..c9f4ea0a2 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldTypeEnum.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldTypeEnum.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,12 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseCustomFieldTypeEnum Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class SignatureRequestResponseCustomFieldTypeEnum { @@ -55,9 +50,7 @@ public static function getAllowableEnumValues() { return [ self::TEXT, - self::CHECKBOX + self::CHECKBOX, ]; } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataBase.php b/sdks/php/src/Model/SignatureRequestResponseDataBase.php index 0beb2d845..5f473fe7f 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataBase.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataBase.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,76 +27,77 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SignatureRequestResponseDataBase Class Doc Comment * * @category Class * @description An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestResponseDataBase implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestResponseDataBase implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'api_id' => 'string', 'signature_id' => 'string', 'name' => 'string', 'required' => 'bool', - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'api_id' => null, 'signature_id' => null, 'name' => null, 'required' => null, - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'api_id' => false, 'signature_id' => false, 'name' => false, 'required' => false, - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -123,8 +122,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -134,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -144,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -153,9 +150,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -164,9 +158,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'signature_id', 'name' => 'name', 'required' => 'required', - 'type' => 'type' + 'type' => 'type', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'setSignatureId', 'name' => 'setName', 'required' => 'setRequired', - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -210,7 +201,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'getSignatureId', 'name' => 'getName', 'required' => 'getRequired', - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -254,7 +245,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -280,7 +270,6 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } - public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -319,14 +308,12 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -343,9 +330,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -359,7 +344,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets api_id * @@ -373,14 +357,14 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id The unique ID for this field. + * @param string|null $api_id the unique ID for this field * * @return self */ - public function setApiId($api_id) + public function setApiId(?string $api_id) { if (is_null($api_id)) { - throw new \InvalidArgumentException('non-nullable api_id cannot be null'); + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -400,14 +384,14 @@ public function getSignatureId() /** * Sets signature_id * - * @param string|null $signature_id The ID of the signature to which this response is linked. + * @param string|null $signature_id the ID of the signature to which this response is linked * * @return self */ - public function setSignatureId($signature_id) + public function setSignatureId(?string $signature_id) { if (is_null($signature_id)) { - throw new \InvalidArgumentException('non-nullable signature_id cannot be null'); + throw new InvalidArgumentException('non-nullable signature_id cannot be null'); } $this->container['signature_id'] = $signature_id; @@ -427,14 +411,14 @@ public function getName() /** * Sets name * - * @param string|null $name The name of the form field. + * @param string|null $name the name of the form field * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -454,14 +438,14 @@ public function getRequired() /** * Sets required * - * @param bool|null $required A boolean value denoting if this field is required. + * @param bool|null $required a boolean value denoting if this field is required * * @return self */ - public function setRequired($required) + public function setRequired(?bool $required) { if (is_null($required)) { - throw new \InvalidArgumentException('non-nullable required cannot be null'); + throw new InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -485,23 +469,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -510,11 +493,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -525,10 +508,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -541,11 +522,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -553,15 +532,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -587,5 +566,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataTypeEnum.php b/sdks/php/src/Model/SignatureRequestResponseDataTypeEnum.php index 59a807635..fd4b6e268 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataTypeEnum.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataTypeEnum.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,12 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; /** * SignatureRequestResponseDataTypeEnum Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class SignatureRequestResponseDataTypeEnum { @@ -76,9 +71,7 @@ public static function getAllowableEnumValues() self::RADIO, self::SIGNATURE, self::TEXT_MERGE, - self::CHECKBOX_MERGE + self::CHECKBOX_MERGE, ]; } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php index 7413b5813..c64a1fbc7 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,16 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseDataValueCheckbox Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueCheckbox extends SignatureRequestResponseDataBase @@ -44,49 +43,49 @@ class SignatureRequestResponseDataValueCheckbox extends SignatureRequestResponse public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'bool' + 'value' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -169,7 +160,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -189,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -233,8 +224,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -249,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseDataValueCheckbox { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseDataValueCheckbox { /** @var SignatureRequestResponseDataValueCheckbox */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueCheckbox::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = parent::listInvalidProperties(); - - return $invalidProperties; + return parent::listInvalidProperties(); } /** @@ -309,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -327,10 +312,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -350,27 +335,26 @@ public function getValue() /** * Sets value * - * @param bool|null $value The value of the form field. + * @param bool|null $value the value of the form field * * @return self */ - public function setValue($value) + public function setValue(?bool $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -379,11 +363,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -394,10 +378,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -410,11 +392,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -422,15 +402,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -456,5 +436,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php index d0d99e61b..96ac1dd3e 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,16 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseDataValueCheckboxMerge Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueCheckboxMerge extends SignatureRequestResponseDataBase @@ -44,49 +43,49 @@ class SignatureRequestResponseDataValueCheckboxMerge extends SignatureRequestRes public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueCheckboxMerge'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string' + 'value' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -169,7 +160,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -189,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -233,8 +224,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -249,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseDataValueCheckboxMerge { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseDataValueCheckboxMerge { /** @var SignatureRequestResponseDataValueCheckboxMerge */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueCheckboxMerge::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = parent::listInvalidProperties(); - - return $invalidProperties; + return parent::listInvalidProperties(); } /** @@ -309,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -327,10 +312,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -350,27 +335,26 @@ public function getValue() /** * Sets value * - * @param string|null $value The value of the form field. + * @param string|null $value the value of the form field * * @return self */ - public function setValue($value) + public function setValue(?string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -379,11 +363,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -394,10 +378,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -410,11 +392,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -422,15 +402,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -456,5 +436,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php b/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php index 2a9185da1..78c8794e0 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,16 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseDataValueDateSigned Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueDateSigned extends SignatureRequestResponseDataBase @@ -44,49 +43,49 @@ class SignatureRequestResponseDataValueDateSigned extends SignatureRequestRespon public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueDateSigned'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string' + 'value' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -169,7 +160,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -189,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -233,8 +224,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -249,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseDataValueDateSigned { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseDataValueDateSigned { /** @var SignatureRequestResponseDataValueDateSigned */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueDateSigned::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = parent::listInvalidProperties(); - - return $invalidProperties; + return parent::listInvalidProperties(); } /** @@ -309,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -327,10 +312,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -350,27 +335,26 @@ public function getValue() /** * Sets value * - * @param string|null $value The value of the form field. + * @param string|null $value the value of the form field * * @return self */ - public function setValue($value) + public function setValue(?string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -379,11 +363,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -394,10 +378,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -410,11 +392,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -422,15 +402,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -456,5 +436,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php b/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php index 75b6996dc..4171a5860 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,16 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseDataValueDropdown Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueDropdown extends SignatureRequestResponseDataBase @@ -44,49 +43,49 @@ class SignatureRequestResponseDataValueDropdown extends SignatureRequestResponse public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueDropdown'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string' + 'value' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -169,7 +160,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -189,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -233,8 +224,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -249,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseDataValueDropdown { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseDataValueDropdown { /** @var SignatureRequestResponseDataValueDropdown */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueDropdown::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = parent::listInvalidProperties(); - - return $invalidProperties; + return parent::listInvalidProperties(); } /** @@ -309,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -327,10 +312,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -350,27 +335,26 @@ public function getValue() /** * Sets value * - * @param string|null $value The value of the form field. + * @param string|null $value the value of the form field * * @return self */ - public function setValue($value) + public function setValue(?string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -379,11 +363,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -394,10 +378,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -410,11 +392,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -422,15 +402,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -456,5 +436,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php b/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php index 7ced50121..25ed14574 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,16 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseDataValueInitials Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueInitials extends SignatureRequestResponseDataBase @@ -44,52 +43,52 @@ class SignatureRequestResponseDataValueInitials extends SignatureRequestResponse public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueInitials'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'value' => 'string', - 'is_signed' => 'bool' + 'is_signed' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'value' => null, - 'is_signed' => null + 'is_signed' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'value' => false, - 'is_signed' => true + 'is_signed' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -173,7 +164,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'value' => 'value', - 'is_signed' => 'is_signed' + 'is_signed' => 'is_signed', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'value' => 'setValue', - 'is_signed' => 'setIsSigned' + 'is_signed' => 'setIsSigned', ]; /** @@ -195,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'value' => 'getValue', - 'is_signed' => 'getIsSigned' + 'is_signed' => 'getIsSigned', ]; /** @@ -239,8 +230,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -256,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('is_signed', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseDataValueInitials { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseDataValueInitials { /** @var SignatureRequestResponseDataValueInitials */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueInitials::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,9 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = parent::listInvalidProperties(); - - return $invalidProperties; + return parent::listInvalidProperties(); } /** @@ -316,7 +302,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -334,10 +319,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -357,14 +342,14 @@ public function getValue() /** * Sets value * - * @param string|null $value The value of the form field. + * @param string|null $value the value of the form field * * @return self */ - public function setValue($value) + public function setValue(?string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; @@ -384,18 +369,18 @@ public function getIsSigned() /** * Sets is_signed * - * @param bool|null $is_signed This field contains the boolean true if the field is signed. + * @param bool|null $is_signed this field contains the boolean true if the field is signed * * @return self */ - public function setIsSigned($is_signed) + public function setIsSigned(?bool $is_signed) { if (is_null($is_signed)) { array_push($this->openAPINullablesSetToNull, 'is_signed'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('is_signed', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -404,14 +389,13 @@ public function setIsSigned($is_signed) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -420,11 +404,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -435,10 +419,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -451,11 +433,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -463,15 +443,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -497,5 +477,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php b/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php index 6259408f1..0c05b0bc9 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,16 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseDataValueRadio Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueRadio extends SignatureRequestResponseDataBase @@ -44,49 +43,49 @@ class SignatureRequestResponseDataValueRadio extends SignatureRequestResponseDat public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueRadio'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'bool' + 'value' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -169,7 +160,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -189,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -233,8 +224,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -249,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseDataValueRadio { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseDataValueRadio { /** @var SignatureRequestResponseDataValueRadio */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueRadio::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = parent::listInvalidProperties(); - - return $invalidProperties; + return parent::listInvalidProperties(); } /** @@ -309,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -327,10 +312,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -350,27 +335,26 @@ public function getValue() /** * Sets value * - * @param bool|null $value The value of the form field. + * @param bool|null $value the value of the form field * * @return self */ - public function setValue($value) + public function setValue(?bool $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -379,11 +363,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -394,10 +378,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -410,11 +392,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -422,15 +402,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -456,5 +436,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php b/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php index 3333c5f6c..b72a8c1fc 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,16 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseDataValueSignature Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueSignature extends SignatureRequestResponseDataBase @@ -44,52 +43,52 @@ class SignatureRequestResponseDataValueSignature extends SignatureRequestRespons public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueSignature'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'value' => 'string', - 'is_signed' => 'bool' + 'is_signed' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'value' => null, - 'is_signed' => null + 'is_signed' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'value' => false, - 'is_signed' => true + 'is_signed' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -173,7 +164,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'value' => 'value', - 'is_signed' => 'is_signed' + 'is_signed' => 'is_signed', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'value' => 'setValue', - 'is_signed' => 'setIsSigned' + 'is_signed' => 'setIsSigned', ]; /** @@ -195,7 +186,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'value' => 'getValue', - 'is_signed' => 'getIsSigned' + 'is_signed' => 'getIsSigned', ]; /** @@ -239,8 +230,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -256,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('is_signed', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseDataValueSignature { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseDataValueSignature { /** @var SignatureRequestResponseDataValueSignature */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueSignature::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,9 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = parent::listInvalidProperties(); - - return $invalidProperties; + return parent::listInvalidProperties(); } /** @@ -316,7 +302,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -334,10 +319,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -357,14 +342,14 @@ public function getValue() /** * Sets value * - * @param string|null $value The value of the form field. + * @param string|null $value the value of the form field * * @return self */ - public function setValue($value) + public function setValue(?string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; @@ -384,18 +369,18 @@ public function getIsSigned() /** * Sets is_signed * - * @param bool|null $is_signed This field contains the boolean true if the field is signed. + * @param bool|null $is_signed this field contains the boolean true if the field is signed * * @return self */ - public function setIsSigned($is_signed) + public function setIsSigned(?bool $is_signed) { if (is_null($is_signed)) { array_push($this->openAPINullablesSetToNull, 'is_signed'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('is_signed', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -404,14 +389,13 @@ public function setIsSigned($is_signed) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -420,11 +404,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -435,10 +419,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -451,11 +433,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -463,15 +443,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -497,5 +477,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueText.php b/sdks/php/src/Model/SignatureRequestResponseDataValueText.php index 668060f61..f4ddd0ff3 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueText.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueText.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,16 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseDataValueText Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueText extends SignatureRequestResponseDataBase @@ -44,49 +43,49 @@ class SignatureRequestResponseDataValueText extends SignatureRequestResponseData public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string' + 'value' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -169,7 +160,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -189,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -233,8 +224,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -249,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseDataValueText { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseDataValueText { /** @var SignatureRequestResponseDataValueText */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueText::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = parent::listInvalidProperties(); - - return $invalidProperties; + return parent::listInvalidProperties(); } /** @@ -309,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -327,10 +312,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -350,27 +335,26 @@ public function getValue() /** * Sets value * - * @param string|null $value The value of the form field. + * @param string|null $value the value of the form field * * @return self */ - public function setValue($value) + public function setValue(?string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -379,11 +363,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -394,10 +378,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -410,11 +392,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -422,15 +402,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -456,5 +436,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php b/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php index d159e98fe..ef64d4b8e 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,16 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SignatureRequestResponseDataValueTextMerge Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SignatureRequestResponseDataValueTextMerge extends SignatureRequestResponseDataBase @@ -44,49 +43,49 @@ class SignatureRequestResponseDataValueTextMerge extends SignatureRequestRespons public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseDataValueTextMerge'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'value' => 'string' + 'value' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -169,7 +160,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -189,7 +180,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -233,8 +224,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -249,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseDataValueTextMerge { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseDataValueTextMerge { /** @var SignatureRequestResponseDataValueTextMerge */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseDataValueTextMerge::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = parent::listInvalidProperties(); - - return $invalidProperties; + return parent::listInvalidProperties(); } /** @@ -309,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -327,10 +312,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -350,27 +335,26 @@ public function getValue() /** * Sets value * - * @param string|null $value The value of the form field. + * @param string|null $value the value of the form field * * @return self */ - public function setValue($value) + public function setValue(?string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -379,11 +363,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -394,10 +378,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -410,11 +392,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -422,15 +402,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -456,5 +436,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestResponseSignatures.php b/sdks/php/src/Model/SignatureRequestResponseSignatures.php index 62376d373..081ebb6d3 100644 --- a/sdks/php/src/Model/SignatureRequestResponseSignatures.php +++ b/sdks/php/src/Model/SignatureRequestResponseSignatures.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SignatureRequestResponseSignatures Class Doc Comment * * @category Class * @description An array of signature objects, 1 for each signer. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestResponseSignatures implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestResponseSignatures implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestResponseSignatures'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'signature_id' => 'string', 'signer_group_guid' => 'string', @@ -77,16 +76,16 @@ class SignatureRequestResponseSignatures implements ModelInterface, ArrayAccess, 'reassigned_by' => 'string', 'reassignment_reason' => 'string', 'reassigned_from' => 'string', - 'error' => 'string' + 'error' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'signature_id' => null, 'signer_group_guid' => null, @@ -106,14 +105,14 @@ class SignatureRequestResponseSignatures implements ModelInterface, ArrayAccess, 'reassigned_by' => null, 'reassignment_reason' => null, 'reassigned_from' => null, - 'error' => null + 'error' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'signature_id' => false, 'signer_group_guid' => true, @@ -133,14 +132,14 @@ class SignatureRequestResponseSignatures implements ModelInterface, ArrayAccess, 'reassigned_by' => true, 'reassignment_reason' => true, 'reassigned_from' => true, - 'error' => true + 'error' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -165,8 +164,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -176,7 +173,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -186,7 +183,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -195,9 +192,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -206,9 +200,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -240,7 +231,7 @@ public function isNullableSetToNull(string $property): bool 'reassigned_by' => 'reassigned_by', 'reassignment_reason' => 'reassignment_reason', 'reassigned_from' => 'reassigned_from', - 'error' => 'error' + 'error' => 'error', ]; /** @@ -267,7 +258,7 @@ public function isNullableSetToNull(string $property): bool 'reassigned_by' => 'setReassignedBy', 'reassignment_reason' => 'setReassignmentReason', 'reassigned_from' => 'setReassignedFrom', - 'error' => 'setError' + 'error' => 'setError', ]; /** @@ -294,7 +285,7 @@ public function isNullableSetToNull(string $property): bool 'reassigned_by' => 'getReassignedBy', 'reassignment_reason' => 'getReassignmentReason', 'reassigned_from' => 'getReassignedFrom', - 'error' => 'getError' + 'error' => 'getError', ]; /** @@ -338,7 +329,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -375,34 +365,33 @@ public function __construct(array $data = null) $this->setIfExists('error', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestResponseSignatures { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestResponseSignatures { /** @var SignatureRequestResponseSignatures */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestResponseSignatures::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -419,9 +408,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -435,7 +422,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets signature_id * @@ -449,14 +435,14 @@ public function getSignatureId() /** * Sets signature_id * - * @param string|null $signature_id Signature identifier. + * @param string|null $signature_id signature identifier * * @return self */ - public function setSignatureId($signature_id) + public function setSignatureId(?string $signature_id) { if (is_null($signature_id)) { - throw new \InvalidArgumentException('non-nullable signature_id cannot be null'); + throw new InvalidArgumentException('non-nullable signature_id cannot be null'); } $this->container['signature_id'] = $signature_id; @@ -480,14 +466,14 @@ public function getSignerGroupGuid() * * @return self */ - public function setSignerGroupGuid($signer_group_guid) + public function setSignerGroupGuid(?string $signer_group_guid) { if (is_null($signer_group_guid)) { array_push($this->openAPINullablesSetToNull, 'signer_group_guid'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signer_group_guid', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -510,14 +496,14 @@ public function getSignerEmailAddress() /** * Sets signer_email_address * - * @param string|null $signer_email_address The email address of the signer. + * @param string|null $signer_email_address the email address of the signer * * @return self */ - public function setSignerEmailAddress($signer_email_address) + public function setSignerEmailAddress(?string $signer_email_address) { if (is_null($signer_email_address)) { - throw new \InvalidArgumentException('non-nullable signer_email_address cannot be null'); + throw new InvalidArgumentException('non-nullable signer_email_address cannot be null'); } $this->container['signer_email_address'] = $signer_email_address; @@ -537,18 +523,18 @@ public function getSignerName() /** * Sets signer_name * - * @param string|null $signer_name The name of the signer. + * @param string|null $signer_name the name of the signer * * @return self */ - public function setSignerName($signer_name) + public function setSignerName(?string $signer_name) { if (is_null($signer_name)) { array_push($this->openAPINullablesSetToNull, 'signer_name'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signer_name', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -571,18 +557,18 @@ public function getSignerRole() /** * Sets signer_role * - * @param string|null $signer_role The role of the signer. + * @param string|null $signer_role the role of the signer * * @return self */ - public function setSignerRole($signer_role) + public function setSignerRole(?string $signer_role) { if (is_null($signer_role)) { array_push($this->openAPINullablesSetToNull, 'signer_role'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signer_role', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -605,18 +591,18 @@ public function getOrder() /** * Sets order * - * @param int|null $order If signer order is assigned this is the 0-based index for this signer. + * @param int|null $order if signer order is assigned this is the 0-based index for this signer * * @return self */ - public function setOrder($order) + public function setOrder(?int $order) { if (is_null($order)) { array_push($this->openAPINullablesSetToNull, 'order'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('order', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -643,10 +629,10 @@ public function getStatusCode() * * @return self */ - public function setStatusCode($status_code) + public function setStatusCode(?string $status_code) { if (is_null($status_code)) { - throw new \InvalidArgumentException('non-nullable status_code cannot be null'); + throw new InvalidArgumentException('non-nullable status_code cannot be null'); } $this->container['status_code'] = $status_code; @@ -666,18 +652,18 @@ public function getDeclineReason() /** * Sets decline_reason * - * @param string|null $decline_reason The reason provided by the signer for declining the request. + * @param string|null $decline_reason the reason provided by the signer for declining the request * * @return self */ - public function setDeclineReason($decline_reason) + public function setDeclineReason(?string $decline_reason) { if (is_null($decline_reason)) { array_push($this->openAPINullablesSetToNull, 'decline_reason'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('decline_reason', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -700,18 +686,18 @@ public function getSignedAt() /** * Sets signed_at * - * @param int|null $signed_at Time that the document was signed or null. + * @param int|null $signed_at time that the document was signed or null * * @return self */ - public function setSignedAt($signed_at) + public function setSignedAt(?int $signed_at) { if (is_null($signed_at)) { array_push($this->openAPINullablesSetToNull, 'signed_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signed_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -734,18 +720,18 @@ public function getLastViewedAt() /** * Sets last_viewed_at * - * @param int|null $last_viewed_at The time that the document was last viewed by this signer or null. + * @param int|null $last_viewed_at the time that the document was last viewed by this signer or null * * @return self */ - public function setLastViewedAt($last_viewed_at) + public function setLastViewedAt(?int $last_viewed_at) { if (is_null($last_viewed_at)) { array_push($this->openAPINullablesSetToNull, 'last_viewed_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('last_viewed_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -768,18 +754,18 @@ public function getLastRemindedAt() /** * Sets last_reminded_at * - * @param int|null $last_reminded_at The time the last reminder email was sent to the signer or null. + * @param int|null $last_reminded_at the time the last reminder email was sent to the signer or null * * @return self */ - public function setLastRemindedAt($last_reminded_at) + public function setLastRemindedAt(?int $last_reminded_at) { if (is_null($last_reminded_at)) { array_push($this->openAPINullablesSetToNull, 'last_reminded_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('last_reminded_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -802,14 +788,14 @@ public function getHasPin() /** * Sets has_pin * - * @param bool|null $has_pin Boolean to indicate whether this signature requires a PIN to access. + * @param bool|null $has_pin boolean to indicate whether this signature requires a PIN to access * * @return self */ - public function setHasPin($has_pin) + public function setHasPin(?bool $has_pin) { if (is_null($has_pin)) { - throw new \InvalidArgumentException('non-nullable has_pin cannot be null'); + throw new InvalidArgumentException('non-nullable has_pin cannot be null'); } $this->container['has_pin'] = $has_pin; @@ -829,18 +815,18 @@ public function getHasSmsAuth() /** * Sets has_sms_auth * - * @param bool|null $has_sms_auth Boolean to indicate whether this signature has SMS authentication enabled. + * @param bool|null $has_sms_auth boolean to indicate whether this signature has SMS authentication enabled * * @return self */ - public function setHasSmsAuth($has_sms_auth) + public function setHasSmsAuth(?bool $has_sms_auth) { if (is_null($has_sms_auth)) { array_push($this->openAPINullablesSetToNull, 'has_sms_auth'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('has_sms_auth', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -863,18 +849,18 @@ public function getHasSmsDelivery() /** * Sets has_sms_delivery * - * @param bool|null $has_sms_delivery Boolean to indicate whether this signature has SMS delivery enabled. + * @param bool|null $has_sms_delivery boolean to indicate whether this signature has SMS delivery enabled * * @return self */ - public function setHasSmsDelivery($has_sms_delivery) + public function setHasSmsDelivery(?bool $has_sms_delivery) { if (is_null($has_sms_delivery)) { array_push($this->openAPINullablesSetToNull, 'has_sms_delivery'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('has_sms_delivery', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -897,18 +883,18 @@ public function getSmsPhoneNumber() /** * Sets sms_phone_number * - * @param string|null $sms_phone_number The SMS phone number used for authentication or signature request delivery. + * @param string|null $sms_phone_number the SMS phone number used for authentication or signature request delivery * * @return self */ - public function setSmsPhoneNumber($sms_phone_number) + public function setSmsPhoneNumber(?string $sms_phone_number) { if (is_null($sms_phone_number)) { array_push($this->openAPINullablesSetToNull, 'sms_phone_number'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('sms_phone_number', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -931,18 +917,18 @@ public function getReassignedBy() /** * Sets reassigned_by * - * @param string|null $reassigned_by Email address of original signer who reassigned to this signer. + * @param string|null $reassigned_by email address of original signer who reassigned to this signer * * @return self */ - public function setReassignedBy($reassigned_by) + public function setReassignedBy(?string $reassigned_by) { if (is_null($reassigned_by)) { array_push($this->openAPINullablesSetToNull, 'reassigned_by'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('reassigned_by', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -965,18 +951,18 @@ public function getReassignmentReason() /** * Sets reassignment_reason * - * @param string|null $reassignment_reason Reason provided by original signer who reassigned to this signer. + * @param string|null $reassignment_reason reason provided by original signer who reassigned to this signer * * @return self */ - public function setReassignmentReason($reassignment_reason) + public function setReassignmentReason(?string $reassignment_reason) { if (is_null($reassignment_reason)) { array_push($this->openAPINullablesSetToNull, 'reassignment_reason'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('reassignment_reason', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -999,18 +985,18 @@ public function getReassignedFrom() /** * Sets reassigned_from * - * @param string|null $reassigned_from Previous signature identifier. + * @param string|null $reassigned_from previous signature identifier * * @return self */ - public function setReassignedFrom($reassigned_from) + public function setReassignedFrom(?string $reassigned_from) { if (is_null($reassigned_from)) { array_push($this->openAPINullablesSetToNull, 'reassigned_from'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('reassigned_from', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1033,18 +1019,18 @@ public function getError() /** * Sets error * - * @param string|null $error Error message pertaining to this signer, or null. + * @param string|null $error error message pertaining to this signer, or null * * @return self */ - public function setError($error) + public function setError(?string $error) { if (is_null($error)) { array_push($this->openAPINullablesSetToNull, 'error'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('error', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1053,14 +1039,13 @@ public function setError($error) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1069,11 +1054,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1084,10 +1069,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1100,11 +1083,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1112,15 +1093,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1146,5 +1127,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestSendRequest.php b/sdks/php/src/Model/SignatureRequestSendRequest.php index af3da3936..600ee133e 100644 --- a/sdks/php/src/Model/SignatureRequestSendRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * SignatureRequestSendRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestSendRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'files' => '\SplFileObject[]', 'file_urls' => 'string[]', @@ -83,16 +83,16 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, \JsonS 'test_mode' => 'bool', 'title' => 'string', 'use_text_tags' => 'bool', - 'expires_at' => 'int' + 'expires_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'files' => 'binary', 'file_urls' => null, @@ -119,14 +119,14 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, \JsonS 'test_mode' => null, 'title' => null, 'use_text_tags' => null, - 'expires_at' => null + 'expires_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'files' => false, 'file_urls' => false, @@ -153,14 +153,14 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, \JsonS 'test_mode' => false, 'title' => false, 'use_text_tags' => false, - 'expires_at' => true + 'expires_at' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -185,8 +185,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -196,7 +194,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -206,7 +204,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -215,9 +213,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -226,9 +221,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -267,7 +259,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'use_text_tags' => 'use_text_tags', - 'expires_at' => 'expires_at' + 'expires_at' => 'expires_at', ]; /** @@ -301,7 +293,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', - 'expires_at' => 'setExpiresAt' + 'expires_at' => 'setExpiresAt', ]; /** @@ -335,7 +327,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', - 'expires_at' => 'getExpiresAt' + 'expires_at' => 'getExpiresAt', ]; /** @@ -379,7 +371,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -423,34 +414,33 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestSendRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestSendRequest { /** @var SignatureRequestSendRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestSendRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -495,11 +485,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -509,14 +498,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -540,10 +529,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -553,7 +542,7 @@ public function setFileUrls($file_urls) /** * Gets signers * - * @return \Dropbox\Sign\Model\SubSignatureRequestSigner[]|null + * @return SubSignatureRequestSigner[]|null */ public function getSigners() { @@ -563,14 +552,14 @@ public function getSigners() /** * Sets signers * - * @param \Dropbox\Sign\Model\SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. * * @return self */ - public function setSigners($signers) + public function setSigners(?array $signers) { if (is_null($signers)) { - throw new \InvalidArgumentException('non-nullable signers cannot be null'); + throw new InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -580,7 +569,7 @@ public function setSigners($signers) /** * Gets grouped_signers * - * @return \Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]|null + * @return SubSignatureRequestGroupedSigners[]|null */ public function getGroupedSigners() { @@ -590,14 +579,14 @@ public function getGroupedSigners() /** * Sets grouped_signers * - * @param \Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. * * @return self */ - public function setGroupedSigners($grouped_signers) + public function setGroupedSigners(?array $grouped_signers) { if (is_null($grouped_signers)) { - throw new \InvalidArgumentException('non-nullable grouped_signers cannot be null'); + throw new InvalidArgumentException('non-nullable grouped_signers cannot be null'); } $this->container['grouped_signers'] = $grouped_signers; @@ -621,10 +610,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline($allow_decline) + public function setAllowDecline(?bool $allow_decline) { if (is_null($allow_decline)) { - throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -648,10 +637,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign($allow_reassign) + public function setAllowReassign(?bool $allow_reassign) { if (is_null($allow_reassign)) { - throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -661,7 +650,7 @@ public function setAllowReassign($allow_reassign) /** * Gets attachments * - * @return \Dropbox\Sign\Model\SubAttachment[]|null + * @return SubAttachment[]|null */ public function getAttachments() { @@ -671,14 +660,14 @@ public function getAttachments() /** * Sets attachments * - * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments($attachments) + public function setAttachments(?array $attachments) { if (is_null($attachments)) { - throw new \InvalidArgumentException('non-nullable attachments cannot be null'); + throw new InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -698,14 +687,14 @@ public function getCcEmailAddresses() /** * Sets cc_email_addresses * - * @param string[]|null $cc_email_addresses The email addresses that should be CCed. + * @param string[]|null $cc_email_addresses the email addresses that should be CCed * * @return self */ - public function setCcEmailAddresses($cc_email_addresses) + public function setCcEmailAddresses(?array $cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -729,10 +718,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(?string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -742,7 +731,7 @@ public function setClientId($client_id) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SubCustomField[]|null + * @return SubCustomField[]|null */ public function getCustomFields() { @@ -752,14 +741,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -769,7 +758,7 @@ public function setCustomFields($custom_fields) /** * Gets field_options * - * @return \Dropbox\Sign\Model\SubFieldOptions|null + * @return SubFieldOptions|null */ public function getFieldOptions() { @@ -779,14 +768,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options + * @param SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions($field_options) + public function setFieldOptions(?SubFieldOptions $field_options) { if (is_null($field_options)) { - throw new \InvalidArgumentException('non-nullable field_options cannot be null'); + throw new InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -796,7 +785,7 @@ public function setFieldOptions($field_options) /** * Gets form_field_groups * - * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null + * @return SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -806,14 +795,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups($form_field_groups) + public function setFormFieldGroups(?array $form_field_groups) { if (is_null($form_field_groups)) { - throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -823,7 +812,7 @@ public function setFormFieldGroups($form_field_groups) /** * Gets form_field_rules * - * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null + * @return SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -833,14 +822,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. + * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` * * @return self */ - public function setFormFieldRules($form_field_rules) + public function setFormFieldRules(?array $form_field_rules) { if (is_null($form_field_rules)) { - throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -850,7 +839,7 @@ public function setFormFieldRules($form_field_rules) /** * Gets form_fields_per_document * - * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null + * @return SubFormFieldsPerDocumentBase[]|null */ public function getFormFieldsPerDocument() { @@ -860,14 +849,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument($form_fields_per_document) + public function setFormFieldsPerDocument(?array $form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -891,10 +880,10 @@ public function getHideTextTags() * * @return self */ - public function setHideTextTags($hide_text_tags) + public function setHideTextTags(?bool $hide_text_tags) { if (is_null($hide_text_tags)) { - throw new \InvalidArgumentException('non-nullable hide_text_tags cannot be null'); + throw new InvalidArgumentException('non-nullable hide_text_tags cannot be null'); } $this->container['hide_text_tags'] = $hide_text_tags; @@ -920,10 +909,10 @@ public function getIsQualifiedSignature() * @return self * @deprecated */ - public function setIsQualifiedSignature($is_qualified_signature) + public function setIsQualifiedSignature(?bool $is_qualified_signature) { if (is_null($is_qualified_signature)) { - throw new \InvalidArgumentException('non-nullable is_qualified_signature cannot be null'); + throw new InvalidArgumentException('non-nullable is_qualified_signature cannot be null'); } $this->container['is_qualified_signature'] = $is_qualified_signature; @@ -947,10 +936,10 @@ public function getIsEid() * * @return self */ - public function setIsEid($is_eid) + public function setIsEid(?bool $is_eid) { if (is_null($is_eid)) { - throw new \InvalidArgumentException('non-nullable is_eid cannot be null'); + throw new InvalidArgumentException('non-nullable is_eid cannot be null'); } $this->container['is_eid'] = $is_eid; @@ -970,17 +959,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that will be sent to the signers. + * @param string|null $message the custom message in the email that will be sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestSendRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestSendRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -1005,13 +994,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -1020,7 +1008,7 @@ public function setMetadata($metadata) /** * Gets signing_options * - * @return \Dropbox\Sign\Model\SubSigningOptions|null + * @return SubSigningOptions|null */ public function getSigningOptions() { @@ -1030,14 +1018,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options + * @param SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions($signing_options) + public function setSigningOptions(?SubSigningOptions $signing_options) { if (is_null($signing_options)) { - throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -1057,14 +1045,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -1084,17 +1072,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that will be sent to the signers. + * @param string|null $subject the subject in the email that will be sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 255)) { - throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestSendRequest., must be smaller than or equal to 255.'); + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestSendRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -1119,10 +1107,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1142,17 +1130,17 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title you want to assign to the SignatureRequest. + * @param string|null $title the title you want to assign to the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } - if ((mb_strlen($title) > 255)) { - throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestSendRequest., must be smaller than or equal to 255.'); + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestSendRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; @@ -1177,10 +1165,10 @@ public function getUseTextTags() * * @return self */ - public function setUseTextTags($use_text_tags) + public function setUseTextTags(?bool $use_text_tags) { if (is_null($use_text_tags)) { - throw new \InvalidArgumentException('non-nullable use_text_tags cannot be null'); + throw new InvalidArgumentException('non-nullable use_text_tags cannot be null'); } $this->container['use_text_tags'] = $use_text_tags; @@ -1204,14 +1192,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1220,14 +1208,13 @@ public function setExpiresAt($expires_at) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1236,11 +1223,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1251,10 +1238,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1267,11 +1252,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1279,15 +1262,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1313,5 +1296,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php index 814d801f6..c58096632 100644 --- a/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,37 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * SignatureRequestSendWithTemplateRequest Class Doc Comment * * @category Class - * @description - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @description + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestSendWithTemplateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_ids' => 'string[]', 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]', @@ -75,16 +75,16 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'signing_redirect_url' => 'string', 'subject' => 'string', 'test_mode' => 'bool', - 'title' => 'string' + 'title' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_ids' => null, 'signers' => null, @@ -102,14 +102,14 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'signing_redirect_url' => null, 'subject' => null, 'test_mode' => null, - 'title' => null + 'title' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'template_ids' => false, 'signers' => false, @@ -127,14 +127,14 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'signing_redirect_url' => false, 'subject' => false, 'test_mode' => false, - 'title' => false + 'title' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -159,8 +159,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -170,7 +168,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -180,7 +178,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -189,9 +187,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -200,9 +195,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -232,7 +224,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'signing_redirect_url', 'subject' => 'subject', 'test_mode' => 'test_mode', - 'title' => 'title' + 'title' => 'title', ]; /** @@ -257,7 +249,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'setSigningRedirectUrl', 'subject' => 'setSubject', 'test_mode' => 'setTestMode', - 'title' => 'setTitle' + 'title' => 'setTitle', ]; /** @@ -282,7 +274,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'getSigningRedirectUrl', 'subject' => 'getSubject', 'test_mode' => 'getTestMode', - 'title' => 'getTitle' + 'title' => 'getTitle', ]; /** @@ -326,7 +318,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -361,34 +352,33 @@ public function __construct(array $data = null) $this->setIfExists('title', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestSendWithTemplateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestSendWithTemplateRequest { /** @var SignatureRequestSendWithTemplateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestSendWithTemplateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -439,7 +429,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template_ids * @@ -453,14 +442,14 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[] $template_ids Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used * * @return self */ - public function setTemplateIds($template_ids) + public function setTemplateIds(array $template_ids) { if (is_null($template_ids)) { - throw new \InvalidArgumentException('non-nullable template_ids cannot be null'); + throw new InvalidArgumentException('non-nullable template_ids cannot be null'); } $this->container['template_ids'] = $template_ids; @@ -470,7 +459,7 @@ public function setTemplateIds($template_ids) /** * Gets signers * - * @return \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[] + * @return SubSignatureRequestTemplateSigner[] */ public function getSigners() { @@ -480,14 +469,14 @@ public function getSigners() /** * Sets signers * - * @param \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[] $signers Add Signers to your Templated-based Signature Request. + * @param SubSignatureRequestTemplateSigner[] $signers add Signers to your Templated-based Signature Request * * @return self */ - public function setSigners($signers) + public function setSigners(array $signers) { if (is_null($signers)) { - throw new \InvalidArgumentException('non-nullable signers cannot be null'); + throw new InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -511,10 +500,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline($allow_decline) + public function setAllowDecline(?bool $allow_decline) { if (is_null($allow_decline)) { - throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -524,7 +513,7 @@ public function setAllowDecline($allow_decline) /** * Gets ccs * - * @return \Dropbox\Sign\Model\SubCC[]|null + * @return SubCC[]|null */ public function getCcs() { @@ -534,14 +523,14 @@ public function getCcs() /** * Sets ccs * - * @param \Dropbox\Sign\Model\SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. * * @return self */ - public function setCcs($ccs) + public function setCcs(?array $ccs) { if (is_null($ccs)) { - throw new \InvalidArgumentException('non-nullable ccs cannot be null'); + throw new InvalidArgumentException('non-nullable ccs cannot be null'); } $this->container['ccs'] = $ccs; @@ -565,10 +554,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(?string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -578,7 +567,7 @@ public function setClientId($client_id) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SubCustomField[]|null + * @return SubCustomField[]|null */ public function getCustomFields() { @@ -588,14 +577,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. + * @param SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -605,7 +594,7 @@ public function setCustomFields($custom_fields) /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -615,14 +604,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -646,10 +635,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -675,10 +664,10 @@ public function getIsQualifiedSignature() * @return self * @deprecated */ - public function setIsQualifiedSignature($is_qualified_signature) + public function setIsQualifiedSignature(?bool $is_qualified_signature) { if (is_null($is_qualified_signature)) { - throw new \InvalidArgumentException('non-nullable is_qualified_signature cannot be null'); + throw new InvalidArgumentException('non-nullable is_qualified_signature cannot be null'); } $this->container['is_qualified_signature'] = $is_qualified_signature; @@ -702,10 +691,10 @@ public function getIsEid() * * @return self */ - public function setIsEid($is_eid) + public function setIsEid(?bool $is_eid) { if (is_null($is_eid)) { - throw new \InvalidArgumentException('non-nullable is_eid cannot be null'); + throw new InvalidArgumentException('non-nullable is_eid cannot be null'); } $this->container['is_eid'] = $is_eid; @@ -725,17 +714,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that will be sent to the signers. + * @param string|null $message the custom message in the email that will be sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -760,13 +749,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -775,7 +763,7 @@ public function setMetadata($metadata) /** * Gets signing_options * - * @return \Dropbox\Sign\Model\SubSigningOptions|null + * @return SubSigningOptions|null */ public function getSigningOptions() { @@ -785,14 +773,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options + * @param SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions($signing_options) + public function setSigningOptions(?SubSigningOptions $signing_options) { if (is_null($signing_options)) { - throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -812,14 +800,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -839,17 +827,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that will be sent to the signers. + * @param string|null $subject the subject in the email that will be sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 255)) { - throw new \InvalidArgumentException('invalid length for $subject when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 255.'); + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -874,10 +862,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -897,31 +885,30 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title you want to assign to the SignatureRequest. + * @param string|null $title the title you want to assign to the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } - if ((mb_strlen($title) > 255)) { - throw new \InvalidArgumentException('invalid length for $title when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 255.'); + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestSendWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -930,11 +917,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -945,10 +932,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -961,11 +946,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -973,15 +956,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1007,5 +990,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SignatureRequestUpdateRequest.php b/sdks/php/src/Model/SignatureRequestUpdateRequest.php index a2ae1ddc3..2a4a33dcf 100644 --- a/sdks/php/src/Model/SignatureRequestUpdateRequest.php +++ b/sdks/php/src/Model/SignatureRequestUpdateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SignatureRequestUpdateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SignatureRequestUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class SignatureRequestUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SignatureRequestUpdateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'signature_id' => 'string', 'email_address' => 'string', 'name' => 'string', - 'expires_at' => 'int' + 'expires_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'signature_id' => null, 'email_address' => 'email', 'name' => null, - 'expires_at' => null + 'expires_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'signature_id' => false, 'email_address' => false, 'name' => false, - 'expires_at' => true + 'expires_at' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'signature_id', 'email_address' => 'email_address', 'name' => 'name', - 'expires_at' => 'expires_at' + 'expires_at' => 'expires_at', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'setSignatureId', 'email_address' => 'setEmailAddress', 'name' => 'setName', - 'expires_at' => 'setExpiresAt' + 'expires_at' => 'setExpiresAt', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'signature_id' => 'getSignatureId', 'email_address' => 'getEmailAddress', 'name' => 'getName', - 'expires_at' => 'getExpiresAt' + 'expires_at' => 'getExpiresAt', ]; /** @@ -247,7 +238,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -269,34 +259,33 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SignatureRequestUpdateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SignatureRequestUpdateRequest { /** @var SignatureRequestUpdateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SignatureRequestUpdateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -332,7 +321,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets signature_id * @@ -346,14 +334,14 @@ public function getSignatureId() /** * Sets signature_id * - * @param string $signature_id The signature ID for the recipient. + * @param string $signature_id the signature ID for the recipient * * @return self */ - public function setSignatureId($signature_id) + public function setSignatureId(string $signature_id) { if (is_null($signature_id)) { - throw new \InvalidArgumentException('non-nullable signature_id cannot be null'); + throw new InvalidArgumentException('non-nullable signature_id cannot be null'); } $this->container['signature_id'] = $signature_id; @@ -377,10 +365,10 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -404,10 +392,10 @@ public function getName() * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -431,14 +419,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -447,14 +435,13 @@ public function setExpiresAt($expires_at) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -463,11 +450,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -478,10 +465,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -494,11 +479,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -506,15 +489,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -540,5 +523,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubAttachment.php b/sdks/php/src/Model/SubAttachment.php index 4d2bdc89c..d41f3459c 100644 --- a/sdks/php/src/Model/SubAttachment.php +++ b/sdks/php/src/Model/SubAttachment.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubAttachment Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubAttachment implements ModelInterface, ArrayAccess, \JsonSerializable +class SubAttachment implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubAttachment'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', 'signer_index' => 'int', 'instructions' => 'string', - 'required' => 'bool' + 'required' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, 'signer_index' => null, 'instructions' => null, - 'required' => null + 'required' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'name' => false, 'signer_index' => false, 'instructions' => false, - 'required' => false + 'required' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'signer_index' => 'signer_index', 'instructions' => 'instructions', - 'required' => 'required' + 'required' => 'required', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'signer_index' => 'setSignerIndex', 'instructions' => 'setInstructions', - 'required' => 'setRequired' + 'required' => 'setRequired', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'signer_index' => 'getSignerIndex', 'instructions' => 'getInstructions', - 'required' => 'getRequired' + 'required' => 'getRequired', ]; /** @@ -247,7 +238,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -269,34 +259,33 @@ public function __construct(array $data = null) $this->setIfExists('required', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubAttachment { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubAttachment { /** @var SubAttachment */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubAttachment::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -335,7 +324,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -349,14 +337,14 @@ public function getName() /** * Sets name * - * @param string $name The name of attachment. + * @param string $name the name of attachment * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -380,10 +368,10 @@ public function getSignerIndex() * * @return self */ - public function setSignerIndex($signer_index) + public function setSignerIndex(int $signer_index) { if (is_null($signer_index)) { - throw new \InvalidArgumentException('non-nullable signer_index cannot be null'); + throw new InvalidArgumentException('non-nullable signer_index cannot be null'); } $this->container['signer_index'] = $signer_index; @@ -403,14 +391,14 @@ public function getInstructions() /** * Sets instructions * - * @param string|null $instructions The instructions for uploading the attachment. + * @param string|null $instructions the instructions for uploading the attachment * * @return self */ - public function setInstructions($instructions) + public function setInstructions(?string $instructions) { if (is_null($instructions)) { - throw new \InvalidArgumentException('non-nullable instructions cannot be null'); + throw new InvalidArgumentException('non-nullable instructions cannot be null'); } $this->container['instructions'] = $instructions; @@ -430,27 +418,26 @@ public function getRequired() /** * Sets required * - * @param bool|null $required Determines if the attachment must be uploaded. + * @param bool|null $required determines if the attachment must be uploaded * * @return self */ - public function setRequired($required) + public function setRequired(?bool $required) { if (is_null($required)) { - throw new \InvalidArgumentException('non-nullable required cannot be null'); + throw new InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -459,11 +446,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -474,10 +461,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -490,11 +475,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -502,15 +485,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -536,5 +519,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubBulkSignerList.php b/sdks/php/src/Model/SubBulkSignerList.php index 7e521412b..d9702bb7d 100644 --- a/sdks/php/src/Model/SubBulkSignerList.php +++ b/sdks/php/src/Model/SubBulkSignerList.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubBulkSignerList Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubBulkSignerList implements ModelInterface, ArrayAccess, \JsonSerializable +class SubBulkSignerList implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubBulkSignerList'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'custom_fields' => '\Dropbox\Sign\Model\SubBulkSignerListCustomField[]', - 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]' + 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'custom_fields' => null, - 'signers' => null + 'signers' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'custom_fields' => false, - 'signers' => false + 'signers' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'custom_fields' => 'custom_fields', - 'signers' => 'signers' + 'signers' => 'signers', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'custom_fields' => 'setCustomFields', - 'signers' => 'setSigners' + 'signers' => 'setSigners', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'custom_fields' => 'getCustomFields', - 'signers' => 'getSigners' + 'signers' => 'getSigners', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('signers', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubBulkSignerList { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubBulkSignerList { /** @var SubBulkSignerList */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubBulkSignerList::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -299,9 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -315,11 +302,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SubBulkSignerListCustomField[]|null + * @return SubBulkSignerListCustomField[]|null */ public function getCustomFields() { @@ -329,14 +315,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SubBulkSignerListCustomField[]|null $custom_fields An array of custom field values. + * @param SubBulkSignerListCustomField[]|null $custom_fields an array of custom field values * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -346,7 +332,7 @@ public function setCustomFields($custom_fields) /** * Gets signers * - * @return \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]|null + * @return SubSignatureRequestTemplateSigner[]|null */ public function getSigners() { @@ -356,27 +342,26 @@ public function getSigners() /** * Sets signers * - * @param \Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]|null $signers Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. Currently only templates with a single role are supported. All signers must have the same `role` value. + * @param SubSignatureRequestTemplateSigner[]|null $signers Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. Currently only templates with a single role are supported. All signers must have the same `role` value. * * @return self */ - public function setSigners($signers) + public function setSigners(?array $signers) { if (is_null($signers)) { - throw new \InvalidArgumentException('non-nullable signers cannot be null'); + throw new InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -385,11 +370,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -400,10 +385,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -416,11 +399,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -428,15 +409,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -462,5 +443,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubBulkSignerListCustomField.php b/sdks/php/src/Model/SubBulkSignerListCustomField.php index 3f71fd021..17f67ac95 100644 --- a/sdks/php/src/Model/SubBulkSignerListCustomField.php +++ b/sdks/php/src/Model/SubBulkSignerListCustomField.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubBulkSignerListCustomField Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubBulkSignerListCustomField implements ModelInterface, ArrayAccess, \JsonSerializable +class SubBulkSignerListCustomField implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubBulkSignerListCustomField'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', - 'value' => 'string' + 'value' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'name' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubBulkSignerListCustomField { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubBulkSignerListCustomField { /** @var SubBulkSignerListCustomField */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubBulkSignerListCustomField::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -321,7 +310,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -339,10 +327,10 @@ public function getName() * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -362,27 +350,26 @@ public function getValue() /** * Sets value * - * @param string $value The value of the custom field. + * @param string $value the value of the custom field * * @return self */ - public function setValue($value) + public function setValue(string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -391,11 +378,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -406,10 +393,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -422,11 +407,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -434,15 +417,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -468,5 +451,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubCC.php b/sdks/php/src/Model/SubCC.php index 93aed7abe..0380a3889 100644 --- a/sdks/php/src/Model/SubCC.php +++ b/sdks/php/src/Model/SubCC.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubCC Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubCC implements ModelInterface, ArrayAccess, \JsonSerializable +class SubCC implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubCC'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'role' => 'string', - 'email_address' => 'string' + 'email_address' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'role' => null, - 'email_address' => 'email' + 'email_address' => 'email', ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'role' => false, - 'email_address' => false + 'email_address' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'role' => 'role', - 'email_address' => 'email_address' + 'email_address' => 'email_address', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'role' => 'setRole', - 'email_address' => 'setEmailAddress' + 'email_address' => 'setEmailAddress', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'role' => 'getRole', - 'email_address' => 'getEmailAddress' + 'email_address' => 'getEmailAddress', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubCC { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubCC { /** @var SubCC */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubCC::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -321,7 +310,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets role * @@ -339,10 +327,10 @@ public function getRole() * * @return self */ - public function setRole($role) + public function setRole(string $role) { if (is_null($role)) { - throw new \InvalidArgumentException('non-nullable role cannot be null'); + throw new InvalidArgumentException('non-nullable role cannot be null'); } $this->container['role'] = $role; @@ -362,27 +350,26 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address The email address of the CC recipient. + * @param string $email_address the email address of the CC recipient * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -391,11 +378,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -406,10 +393,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -422,11 +407,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -434,15 +417,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -468,5 +451,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubCustomField.php b/sdks/php/src/Model/SubCustomField.php index 1c774c664..e853f9eb1 100644 --- a/sdks/php/src/Model/SubCustomField.php +++ b/sdks/php/src/Model/SubCustomField.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,73 +27,74 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubCustomField Class Doc Comment * * @category Class * @description When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubCustomField implements ModelInterface, ArrayAccess, \JsonSerializable +class SubCustomField implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubCustomField'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', 'editor' => 'string', 'required' => 'bool', - 'value' => 'string' + 'value' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, 'editor' => null, 'required' => null, - 'value' => null + 'value' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'name' => false, 'editor' => false, 'required' => false, - 'value' => false + 'value' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,8 +119,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -131,7 +128,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +138,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,9 +147,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -161,9 +155,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'editor' => 'editor', 'required' => 'required', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'editor' => 'setEditor', 'required' => 'setRequired', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'editor' => 'getEditor', 'required' => 'getRequired', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -248,7 +239,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -270,34 +260,33 @@ public function __construct(array $data = null) $this->setIfExists('value', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubCustomField { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubCustomField { /** @var SubCustomField */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubCustomField::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -333,7 +322,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -351,10 +339,10 @@ public function getName() * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -378,10 +366,10 @@ public function getEditor() * * @return self */ - public function setEditor($editor) + public function setEditor(?string $editor) { if (is_null($editor)) { - throw new \InvalidArgumentException('non-nullable editor cannot be null'); + throw new InvalidArgumentException('non-nullable editor cannot be null'); } $this->container['editor'] = $editor; @@ -405,10 +393,10 @@ public function getRequired() * * @return self */ - public function setRequired($required) + public function setRequired(?bool $required) { if (is_null($required)) { - throw new \InvalidArgumentException('non-nullable required cannot be null'); + throw new InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -428,27 +416,26 @@ public function getValue() /** * Sets value * - * @param string|null $value The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing. + * @param string|null $value the string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing * * @return self */ - public function setValue($value) + public function setValue(?string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -457,11 +444,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -472,10 +459,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -488,11 +473,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -500,15 +483,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -534,5 +517,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubEditorOptions.php b/sdks/php/src/Model/SubEditorOptions.php index e1b2b7368..cd15d5965 100644 --- a/sdks/php/src/Model/SubEditorOptions.php +++ b/sdks/php/src/Model/SubEditorOptions.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,67 +27,68 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubEditorOptions Class Doc Comment * * @category Class * @description This allows the requester to specify editor options when a preparing a document - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubEditorOptions implements ModelInterface, ArrayAccess, \JsonSerializable +class SubEditorOptions implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubEditorOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'allow_edit_signers' => 'bool', - 'allow_edit_documents' => 'bool' + 'allow_edit_documents' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'allow_edit_signers' => null, - 'allow_edit_documents' => null + 'allow_edit_documents' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'allow_edit_signers' => false, - 'allow_edit_documents' => false + 'allow_edit_documents' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -172,7 +163,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'allow_edit_signers' => 'allow_edit_signers', - 'allow_edit_documents' => 'allow_edit_documents' + 'allow_edit_documents' => 'allow_edit_documents', ]; /** @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'allow_edit_signers' => 'setAllowEditSigners', - 'allow_edit_documents' => 'setAllowEditDocuments' + 'allow_edit_documents' => 'setAllowEditDocuments', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'allow_edit_signers' => 'getAllowEditSigners', - 'allow_edit_documents' => 'getAllowEditDocuments' + 'allow_edit_documents' => 'getAllowEditDocuments', ]; /** @@ -236,7 +227,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -256,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('allow_edit_documents', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubEditorOptions { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubEditorOptions { /** @var SubEditorOptions */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubEditorOptions::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,9 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -316,7 +303,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets allow_edit_signers * @@ -334,10 +320,10 @@ public function getAllowEditSigners() * * @return self */ - public function setAllowEditSigners($allow_edit_signers) + public function setAllowEditSigners(?bool $allow_edit_signers) { if (is_null($allow_edit_signers)) { - throw new \InvalidArgumentException('non-nullable allow_edit_signers cannot be null'); + throw new InvalidArgumentException('non-nullable allow_edit_signers cannot be null'); } $this->container['allow_edit_signers'] = $allow_edit_signers; @@ -361,23 +347,22 @@ public function getAllowEditDocuments() * * @return self */ - public function setAllowEditDocuments($allow_edit_documents) + public function setAllowEditDocuments(?bool $allow_edit_documents) { if (is_null($allow_edit_documents)) { - throw new \InvalidArgumentException('non-nullable allow_edit_documents cannot be null'); + throw new InvalidArgumentException('non-nullable allow_edit_documents cannot be null'); } $this->container['allow_edit_documents'] = $allow_edit_documents; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -386,11 +371,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -401,10 +386,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -417,11 +400,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -429,15 +410,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -463,5 +444,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFieldOptions.php b/sdks/php/src/Model/SubFieldOptions.php index a48d02d16..974daa4a9 100644 --- a/sdks/php/src/Model/SubFieldOptions.php +++ b/sdks/php/src/Model/SubFieldOptions.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,64 +27,65 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubFieldOptions Class Doc Comment * * @category Class * @description This allows the requester to specify field options for a signature request. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFieldOptions implements ModelInterface, ArrayAccess, \JsonSerializable +class SubFieldOptions implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFieldOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'date_format' => 'string' + 'date_format' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'date_format' => null + 'date_format' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'date_format' => false + 'date_format' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -168,7 +159,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'date_format' => 'date_format' + 'date_format' => 'date_format', ]; /** @@ -177,7 +168,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'date_format' => 'setDateFormat' + 'date_format' => 'setDateFormat', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'date_format' => 'getDateFormat' + 'date_format' => 'getDateFormat', ]; /** @@ -272,34 +263,33 @@ public function __construct(array $data = null) $this->setIfExists('date_format', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFieldOptions { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFieldOptions { /** @var SubFieldOptions */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFieldOptions::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -344,7 +334,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets date_format * @@ -358,18 +347,18 @@ public function getDateFormat() /** * Sets date_format * - * @param string $date_format Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **NOTE:** Only available for Premium and higher. + * @param string $date_format allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **NOTE:** Only available for Premium and higher * * @return self */ - public function setDateFormat($date_format) + public function setDateFormat(string $date_format) { if (is_null($date_format)) { - throw new \InvalidArgumentException('non-nullable date_format cannot be null'); + throw new InvalidArgumentException('non-nullable date_format cannot be null'); } $allowedValues = $this->getDateFormatAllowableValues(); if (!in_array($date_format, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'date_format', must be one of '%s'", $date_format, @@ -381,14 +370,13 @@ public function setDateFormat($date_format) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -397,11 +385,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -412,10 +400,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -428,11 +414,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -440,15 +424,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -474,5 +458,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldGroup.php b/sdks/php/src/Model/SubFormFieldGroup.php index 16756976f..2ff53e101 100644 --- a/sdks/php/src/Model/SubFormFieldGroup.php +++ b/sdks/php/src/Model/SubFormFieldGroup.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubFormFieldGroup Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFormFieldGroup implements ModelInterface, ArrayAccess, \JsonSerializable +class SubFormFieldGroup implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldGroup'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'group_id' => 'string', 'group_label' => 'string', - 'requirement' => 'string' + 'requirement' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'group_id' => null, 'group_label' => null, - 'requirement' => null + 'requirement' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'group_id' => false, 'group_label' => false, - 'requirement' => false + 'requirement' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'group_id' => 'group_id', 'group_label' => 'group_label', - 'requirement' => 'requirement' + 'requirement' => 'requirement', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'group_id' => 'setGroupId', 'group_label' => 'setGroupLabel', - 'requirement' => 'setRequirement' + 'requirement' => 'setRequirement', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'group_id' => 'getGroupId', 'group_label' => 'getGroupLabel', - 'requirement' => 'getRequirement' + 'requirement' => 'getRequirement', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('requirement', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldGroup { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldGroup { /** @var SubFormFieldGroup */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldGroup::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -331,7 +320,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets group_id * @@ -349,10 +337,10 @@ public function getGroupId() * * @return self */ - public function setGroupId($group_id) + public function setGroupId(string $group_id) { if (is_null($group_id)) { - throw new \InvalidArgumentException('non-nullable group_id cannot be null'); + throw new InvalidArgumentException('non-nullable group_id cannot be null'); } $this->container['group_id'] = $group_id; @@ -376,10 +364,10 @@ public function getGroupLabel() * * @return self */ - public function setGroupLabel($group_label) + public function setGroupLabel(string $group_label) { if (is_null($group_label)) { - throw new \InvalidArgumentException('non-nullable group_label cannot be null'); + throw new InvalidArgumentException('non-nullable group_label cannot be null'); } $this->container['group_label'] = $group_label; @@ -403,23 +391,22 @@ public function getRequirement() * * @return self */ - public function setRequirement($requirement) + public function setRequirement(string $requirement) { if (is_null($requirement)) { - throw new \InvalidArgumentException('non-nullable requirement cannot be null'); + throw new InvalidArgumentException('non-nullable requirement cannot be null'); } $this->container['requirement'] = $requirement; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -428,11 +415,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -443,10 +430,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -459,11 +444,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -471,15 +454,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -505,5 +488,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldRule.php b/sdks/php/src/Model/SubFormFieldRule.php index c571835bf..094d8217c 100644 --- a/sdks/php/src/Model/SubFormFieldRule.php +++ b/sdks/php/src/Model/SubFormFieldRule.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubFormFieldRule Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFormFieldRule implements ModelInterface, ArrayAccess, \JsonSerializable +class SubFormFieldRule implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldRule'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'id' => 'string', 'trigger_operator' => 'string', 'triggers' => '\Dropbox\Sign\Model\SubFormFieldRuleTrigger[]', - 'actions' => '\Dropbox\Sign\Model\SubFormFieldRuleAction[]' + 'actions' => '\Dropbox\Sign\Model\SubFormFieldRuleAction[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'id' => null, 'trigger_operator' => null, 'triggers' => null, - 'actions' => null + 'actions' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'id' => false, 'trigger_operator' => false, 'triggers' => false, - 'actions' => false + 'actions' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'id', 'trigger_operator' => 'trigger_operator', 'triggers' => 'triggers', - 'actions' => 'actions' + 'actions' => 'actions', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'setId', 'trigger_operator' => 'setTriggerOperator', 'triggers' => 'setTriggers', - 'actions' => 'setActions' + 'actions' => 'setActions', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'getId', 'trigger_operator' => 'getTriggerOperator', 'triggers' => 'getTriggers', - 'actions' => 'getActions' + 'actions' => 'getActions', ]; /** @@ -247,7 +238,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -269,34 +259,33 @@ public function __construct(array $data = null) $this->setIfExists('actions', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldRule { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldRule { /** @var SubFormFieldRule */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldRule::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -324,18 +313,18 @@ public function listInvalidProperties() if ($this->container['triggers'] === null) { $invalidProperties[] = "'triggers' can't be null"; } - if ((count($this->container['triggers']) > 1)) { + if (count($this->container['triggers']) > 1) { $invalidProperties[] = "invalid value for 'triggers', number of items must be less than or equal to 1."; } - if ((count($this->container['triggers']) < 1)) { + if (count($this->container['triggers']) < 1) { $invalidProperties[] = "invalid value for 'triggers', number of items must be greater than or equal to 1."; } if ($this->container['actions'] === null) { $invalidProperties[] = "'actions' can't be null"; } - if ((count($this->container['actions']) < 1)) { + if (count($this->container['actions']) < 1) { $invalidProperties[] = "invalid value for 'actions', number of items must be greater than or equal to 1."; } @@ -353,7 +342,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets id * @@ -367,14 +355,14 @@ public function getId() /** * Sets id * - * @param string $id Must be unique across all defined rules. + * @param string $id must be unique across all defined rules * * @return self */ - public function setId($id) + public function setId(string $id) { if (is_null($id)) { - throw new \InvalidArgumentException('non-nullable id cannot be null'); + throw new InvalidArgumentException('non-nullable id cannot be null'); } $this->container['id'] = $id; @@ -398,10 +386,10 @@ public function getTriggerOperator() * * @return self */ - public function setTriggerOperator($trigger_operator) + public function setTriggerOperator(string $trigger_operator) { if (is_null($trigger_operator)) { - throw new \InvalidArgumentException('non-nullable trigger_operator cannot be null'); + throw new InvalidArgumentException('non-nullable trigger_operator cannot be null'); } $this->container['trigger_operator'] = $trigger_operator; @@ -411,7 +399,7 @@ public function setTriggerOperator($trigger_operator) /** * Gets triggers * - * @return \Dropbox\Sign\Model\SubFormFieldRuleTrigger[] + * @return SubFormFieldRuleTrigger[] */ public function getTriggers() { @@ -421,21 +409,21 @@ public function getTriggers() /** * Sets triggers * - * @param \Dropbox\Sign\Model\SubFormFieldRuleTrigger[] $triggers An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed. + * @param SubFormFieldRuleTrigger[] $triggers An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed. * * @return self */ - public function setTriggers($triggers) + public function setTriggers(array $triggers) { if (is_null($triggers)) { - throw new \InvalidArgumentException('non-nullable triggers cannot be null'); + throw new InvalidArgumentException('non-nullable triggers cannot be null'); } - if ((count($triggers) > 1)) { - throw new \InvalidArgumentException('invalid value for $triggers when calling SubFormFieldRule., number of items must be less than or equal to 1.'); + if (count($triggers) > 1) { + throw new InvalidArgumentException('invalid value for $triggers when calling SubFormFieldRule., number of items must be less than or equal to 1.'); } - if ((count($triggers) < 1)) { - throw new \InvalidArgumentException('invalid length for $triggers when calling SubFormFieldRule., number of items must be greater than or equal to 1.'); + if (count($triggers) < 1) { + throw new InvalidArgumentException('invalid length for $triggers when calling SubFormFieldRule., number of items must be greater than or equal to 1.'); } $this->container['triggers'] = $triggers; @@ -445,7 +433,7 @@ public function setTriggers($triggers) /** * Gets actions * - * @return \Dropbox\Sign\Model\SubFormFieldRuleAction[] + * @return SubFormFieldRuleAction[] */ public function getActions() { @@ -455,32 +443,30 @@ public function getActions() /** * Sets actions * - * @param \Dropbox\Sign\Model\SubFormFieldRuleAction[] $actions An array of action definitions, the \"then that\" part of \"if this, **then that**\". Any number of actions may be attached to a single rule. + * @param SubFormFieldRuleAction[] $actions An array of action definitions, the \"then that\" part of \"if this, **then that**\". Any number of actions may be attached to a single rule. * * @return self */ - public function setActions($actions) + public function setActions(array $actions) { if (is_null($actions)) { - throw new \InvalidArgumentException('non-nullable actions cannot be null'); + throw new InvalidArgumentException('non-nullable actions cannot be null'); } - - if ((count($actions) < 1)) { - throw new \InvalidArgumentException('invalid length for $actions when calling SubFormFieldRule., number of items must be greater than or equal to 1.'); + if (count($actions) < 1) { + throw new InvalidArgumentException('invalid length for $actions when calling SubFormFieldRule., number of items must be greater than or equal to 1.'); } $this->container['actions'] = $actions; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -489,11 +475,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -504,10 +490,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -520,11 +504,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -532,15 +514,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -566,5 +548,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldRuleAction.php b/sdks/php/src/Model/SubFormFieldRuleAction.php index bbc074c98..458b5822f 100644 --- a/sdks/php/src/Model/SubFormFieldRuleAction.php +++ b/sdks/php/src/Model/SubFormFieldRuleAction.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubFormFieldRuleAction Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFormFieldRuleAction implements ModelInterface, ArrayAccess, \JsonSerializable +class SubFormFieldRuleAction implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldRuleAction'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'hidden' => 'bool', 'type' => 'string', 'field_id' => 'string', - 'group_id' => 'string' + 'group_id' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'hidden' => null, 'type' => null, 'field_id' => null, - 'group_id' => null + 'group_id' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'hidden' => false, 'type' => false, 'field_id' => false, - 'group_id' => false + 'group_id' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'hidden' => 'hidden', 'type' => 'type', 'field_id' => 'field_id', - 'group_id' => 'group_id' + 'group_id' => 'group_id', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'hidden' => 'setHidden', 'type' => 'setType', 'field_id' => 'setFieldId', - 'group_id' => 'setGroupId' + 'group_id' => 'setGroupId', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'hidden' => 'getHidden', 'type' => 'getType', 'field_id' => 'getFieldId', - 'group_id' => 'getGroupId' + 'group_id' => 'getGroupId', ]; /** @@ -284,34 +275,33 @@ public function __construct(array $data = null) $this->setIfExists('group_id', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldRuleAction { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldRuleAction { /** @var SubFormFieldRuleAction */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldRuleAction::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -359,7 +349,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets hidden * @@ -373,14 +362,14 @@ public function getHidden() /** * Sets hidden * - * @param bool $hidden `true` to hide the target field when rule is satisfied, otherwise `false`. + * @param bool $hidden `true` to hide the target field when rule is satisfied, otherwise `false` * * @return self */ - public function setHidden($hidden) + public function setHidden(bool $hidden) { if (is_null($hidden)) { - throw new \InvalidArgumentException('non-nullable hidden cannot be null'); + throw new InvalidArgumentException('non-nullable hidden cannot be null'); } $this->container['hidden'] = $hidden; @@ -404,14 +393,14 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'type', must be one of '%s'", $type, @@ -441,10 +430,10 @@ public function getFieldId() * * @return self */ - public function setFieldId($field_id) + public function setFieldId(?string $field_id) { if (is_null($field_id)) { - throw new \InvalidArgumentException('non-nullable field_id cannot be null'); + throw new InvalidArgumentException('non-nullable field_id cannot be null'); } $this->container['field_id'] = $field_id; @@ -468,23 +457,22 @@ public function getGroupId() * * @return self */ - public function setGroupId($group_id) + public function setGroupId(?string $group_id) { if (is_null($group_id)) { - throw new \InvalidArgumentException('non-nullable group_id cannot be null'); + throw new InvalidArgumentException('non-nullable group_id cannot be null'); } $this->container['group_id'] = $group_id; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -493,11 +481,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -508,10 +496,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -524,11 +510,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -536,15 +520,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -570,5 +554,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldRuleTrigger.php b/sdks/php/src/Model/SubFormFieldRuleTrigger.php index 3f8b858cf..0ab5768e0 100644 --- a/sdks/php/src/Model/SubFormFieldRuleTrigger.php +++ b/sdks/php/src/Model/SubFormFieldRuleTrigger.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,72 +27,73 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubFormFieldRuleTrigger Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFormFieldRuleTrigger implements ModelInterface, ArrayAccess, \JsonSerializable +class SubFormFieldRuleTrigger implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldRuleTrigger'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'id' => 'string', 'operator' => 'string', 'value' => 'string', - 'values' => 'string[]' + 'values' => 'string[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'id' => null, 'operator' => null, 'value' => null, - 'values' => null + 'values' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'id' => false, 'operator' => false, 'value' => false, - 'values' => false + 'values' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -119,8 +118,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -130,7 +127,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -140,7 +137,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -149,9 +146,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -160,9 +154,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -179,7 +170,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'id', 'operator' => 'operator', 'value' => 'value', - 'values' => 'values' + 'values' => 'values', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'setId', 'operator' => 'setOperator', 'value' => 'setValue', - 'values' => 'setValues' + 'values' => 'setValues', ]; /** @@ -203,7 +194,7 @@ public function isNullableSetToNull(string $property): bool 'id' => 'getId', 'operator' => 'getOperator', 'value' => 'getValue', - 'values' => 'getValues' + 'values' => 'getValues', ]; /** @@ -290,34 +281,33 @@ public function __construct(array $data = null) $this->setIfExists('values', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldRuleTrigger { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldRuleTrigger { /** @var SubFormFieldRuleTrigger */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldRuleTrigger::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -365,7 +355,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets id * @@ -383,10 +372,10 @@ public function getId() * * @return self */ - public function setId($id) + public function setId(string $id) { if (is_null($id)) { - throw new \InvalidArgumentException('non-nullable id cannot be null'); + throw new InvalidArgumentException('non-nullable id cannot be null'); } $this->container['id'] = $id; @@ -410,14 +399,14 @@ public function getOperator() * * @return self */ - public function setOperator($operator) + public function setOperator(string $operator) { if (is_null($operator)) { - throw new \InvalidArgumentException('non-nullable operator cannot be null'); + throw new InvalidArgumentException('non-nullable operator cannot be null'); } $allowedValues = $this->getOperatorAllowableValues(); if (!in_array($operator, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'operator', must be one of '%s'", $operator, @@ -447,10 +436,10 @@ public function getValue() * * @return self */ - public function setValue($value) + public function setValue(?string $value) { if (is_null($value)) { - throw new \InvalidArgumentException('non-nullable value cannot be null'); + throw new InvalidArgumentException('non-nullable value cannot be null'); } $this->container['value'] = $value; @@ -474,23 +463,22 @@ public function getValues() * * @return self */ - public function setValues($values) + public function setValues(?array $values) { if (is_null($values)) { - throw new \InvalidArgumentException('non-nullable values cannot be null'); + throw new InvalidArgumentException('non-nullable values cannot be null'); } $this->container['values'] = $values; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -499,11 +487,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -514,10 +502,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -530,11 +516,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -542,15 +526,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -576,5 +560,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php b/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php index a6f4203d5..68158bf5a 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentBase Class Doc Comment * * @category Class * @description The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubFormFieldsPerDocumentBase implements ModelInterface, ArrayAccess, \JsonSerializable +class SubFormFieldsPerDocumentBase implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'document_index' => 'int', 'api_id' => 'string', @@ -69,16 +68,16 @@ class SubFormFieldsPerDocumentBase implements ModelInterface, ArrayAccess, \Json 'x' => 'int', 'y' => 'int', 'name' => 'string', - 'page' => 'int' + 'page' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'document_index' => null, 'api_id' => null, @@ -90,14 +89,14 @@ class SubFormFieldsPerDocumentBase implements ModelInterface, ArrayAccess, \Json 'x' => null, 'y' => null, 'name' => null, - 'page' => null + 'page' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'document_index' => false, 'api_id' => false, @@ -109,14 +108,14 @@ class SubFormFieldsPerDocumentBase implements ModelInterface, ArrayAccess, \Json 'x' => false, 'y' => false, 'name' => false, - 'page' => true + 'page' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -141,8 +140,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -152,7 +149,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -162,7 +159,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -171,9 +168,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -182,9 +176,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -208,7 +199,7 @@ public function isNullableSetToNull(string $property): bool 'x' => 'x', 'y' => 'y', 'name' => 'name', - 'page' => 'page' + 'page' => 'page', ]; /** @@ -227,7 +218,7 @@ public function isNullableSetToNull(string $property): bool 'x' => 'setX', 'y' => 'setY', 'name' => 'setName', - 'page' => 'setPage' + 'page' => 'setPage', ]; /** @@ -246,7 +237,7 @@ public function isNullableSetToNull(string $property): bool 'x' => 'getX', 'y' => 'getY', 'name' => 'getName', - 'page' => 'getPage' + 'page' => 'getPage', ]; /** @@ -290,7 +281,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -322,7 +312,6 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } - public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -364,14 +353,12 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -431,7 +418,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets document_index * @@ -445,14 +431,14 @@ public function getDocumentIndex() /** * Sets document_index * - * @param int $document_index Represents the integer index of the `file` or `file_url` document the field should be attached to. + * @param int $document_index represents the integer index of the `file` or `file_url` document the field should be attached to * * @return self */ - public function setDocumentIndex($document_index) + public function setDocumentIndex(int $document_index) { if (is_null($document_index)) { - throw new \InvalidArgumentException('non-nullable document_index cannot be null'); + throw new InvalidArgumentException('non-nullable document_index cannot be null'); } $this->container['document_index'] = $document_index; @@ -472,14 +458,14 @@ public function getApiId() /** * Sets api_id * - * @param string $api_id An identifier for the field that is unique across all documents in the request. + * @param string $api_id an identifier for the field that is unique across all documents in the request * * @return self */ - public function setApiId($api_id) + public function setApiId(string $api_id) { if (is_null($api_id)) { - throw new \InvalidArgumentException('non-nullable api_id cannot be null'); + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -499,14 +485,14 @@ public function getHeight() /** * Sets height * - * @param int $height Size of the field in pixels. + * @param int $height size of the field in pixels * * @return self */ - public function setHeight($height) + public function setHeight(int $height) { if (is_null($height)) { - throw new \InvalidArgumentException('non-nullable height cannot be null'); + throw new InvalidArgumentException('non-nullable height cannot be null'); } $this->container['height'] = $height; @@ -526,14 +512,14 @@ public function getRequired() /** * Sets required * - * @param bool $required Whether this field is required. + * @param bool $required whether this field is required * * @return self */ - public function setRequired($required) + public function setRequired(bool $required) { if (is_null($required)) { - throw new \InvalidArgumentException('non-nullable required cannot be null'); + throw new InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -557,10 +543,10 @@ public function getSigner() * * @return self */ - public function setSigner($signer) + public function setSigner(string $signer) { if (is_null($signer)) { - throw new \InvalidArgumentException('non-nullable signer cannot be null'); + throw new InvalidArgumentException('non-nullable signer cannot be null'); } $this->container['signer'] = $signer; @@ -584,10 +570,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -607,14 +593,14 @@ public function getWidth() /** * Sets width * - * @param int $width Size of the field in pixels. + * @param int $width size of the field in pixels * * @return self */ - public function setWidth($width) + public function setWidth(int $width) { if (is_null($width)) { - throw new \InvalidArgumentException('non-nullable width cannot be null'); + throw new InvalidArgumentException('non-nullable width cannot be null'); } $this->container['width'] = $width; @@ -634,14 +620,14 @@ public function getX() /** * Sets x * - * @param int $x Location coordinates of the field in pixels. + * @param int $x location coordinates of the field in pixels * * @return self */ - public function setX($x) + public function setX(int $x) { if (is_null($x)) { - throw new \InvalidArgumentException('non-nullable x cannot be null'); + throw new InvalidArgumentException('non-nullable x cannot be null'); } $this->container['x'] = $x; @@ -661,14 +647,14 @@ public function getY() /** * Sets y * - * @param int $y Location coordinates of the field in pixels. + * @param int $y location coordinates of the field in pixels * * @return self */ - public function setY($y) + public function setY(int $y) { if (is_null($y)) { - throw new \InvalidArgumentException('non-nullable y cannot be null'); + throw new InvalidArgumentException('non-nullable y cannot be null'); } $this->container['y'] = $y; @@ -688,14 +674,14 @@ public function getName() /** * Sets name * - * @param string|null $name Display name for the field. + * @param string|null $name display name for the field * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -719,14 +705,14 @@ public function getPage() * * @return self */ - public function setPage($page) + public function setPage(?int $page) { if (is_null($page)) { array_push($this->openAPINullablesSetToNull, 'page'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('page', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -735,14 +721,13 @@ public function setPage($page) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -751,11 +736,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -766,10 +751,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -782,11 +765,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -794,15 +775,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -828,5 +809,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentCheckbox.php b/sdks/php/src/Model/SubFormFieldsPerDocumentCheckbox.php index 770a00dbe..c023916c7 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentCheckbox.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentCheckbox.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentCheckbox Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentCheckbox extends SubFormFieldsPerDocumentBase @@ -45,52 +44,52 @@ class SubFormFieldsPerDocumentCheckbox extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'is_checked' => 'bool', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'is_checked' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'is_checked' => false, - 'group' => false + 'group' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,8 +114,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -126,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -136,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -145,9 +142,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -156,9 +150,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -174,7 +165,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'is_checked' => 'is_checked', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'is_checked' => 'setIsChecked', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -196,7 +187,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'is_checked' => 'getIsChecked', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -240,8 +231,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -257,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldsPerDocumentCheckbox { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldsPerDocumentCheckbox { /** @var SubFormFieldsPerDocumentCheckbox */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentCheckbox::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -323,7 +311,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -341,10 +328,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -364,14 +351,14 @@ public function getIsChecked() /** * Sets is_checked * - * @param bool $is_checked `true` for checking the checkbox field by default, otherwise `false`. + * @param bool $is_checked `true` for checking the checkbox field by default, otherwise `false` * * @return self */ - public function setIsChecked($is_checked) + public function setIsChecked(bool $is_checked) { if (is_null($is_checked)) { - throw new \InvalidArgumentException('non-nullable is_checked cannot be null'); + throw new InvalidArgumentException('non-nullable is_checked cannot be null'); } $this->container['is_checked'] = $is_checked; @@ -391,27 +378,26 @@ public function getGroup() /** * Sets group * - * @param string|null $group String referencing group defined in `form_field_groups` parameter. + * @param string|null $group string referencing group defined in `form_field_groups` parameter * * @return self */ - public function setGroup($group) + public function setGroup(?string $group) { if (is_null($group)) { - throw new \InvalidArgumentException('non-nullable group cannot be null'); + throw new InvalidArgumentException('non-nullable group cannot be null'); } $this->container['group'] = $group; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -420,11 +406,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -435,10 +421,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -451,11 +435,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -463,15 +445,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -497,5 +479,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentCheckboxMerge.php b/sdks/php/src/Model/SubFormFieldsPerDocumentCheckboxMerge.php index 24cddc531..c3924079b 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentCheckboxMerge.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentCheckboxMerge.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentCheckboxMerge Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentCheckboxMerge extends SubFormFieldsPerDocumentBase @@ -45,46 +44,46 @@ class SubFormFieldsPerDocumentCheckboxMerge extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentCheckboxMerge'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'checkbox-merge'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldsPerDocumentCheckboxMerge { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldsPerDocumentCheckboxMerge { /** @var SubFormFieldsPerDocumentCheckboxMerge */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentCheckboxMerge::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentDateSigned.php b/sdks/php/src/Model/SubFormFieldsPerDocumentDateSigned.php index ee6ae9e8c..5902025ad 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentDateSigned.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentDateSigned.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentDateSigned Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentDateSigned extends SubFormFieldsPerDocumentBase @@ -45,52 +44,52 @@ class SubFormFieldsPerDocumentDateSigned extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentDateSigned'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'font_family' => 'string', - 'font_size' => 'int' + 'font_size' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'font_family' => null, - 'font_size' => null + 'font_size' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'font_family' => false, - 'font_size' => false + 'font_size' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,8 +114,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -126,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -136,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -145,9 +142,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -156,9 +150,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -174,7 +165,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'font_family' => 'font_family', - 'font_size' => 'font_size' + 'font_size' => 'font_size', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'font_family' => 'setFontFamily', - 'font_size' => 'setFontSize' + 'font_size' => 'setFontSize', ]; /** @@ -196,7 +187,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'font_family' => 'getFontFamily', - 'font_size' => 'getFontSize' + 'font_size' => 'getFontSize', ]; /** @@ -284,7 +275,6 @@ public function getFontFamilyAllowableValues() ]; } - /** * Constructor * @@ -300,34 +290,33 @@ public function __construct(array $data = null) $this->setIfExists('font_size', $data ?? [], 12); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldsPerDocumentDateSigned { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldsPerDocumentDateSigned { /** @var SubFormFieldsPerDocumentDateSigned */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentDateSigned::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -372,7 +361,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -390,10 +378,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -413,18 +401,18 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family Font family for the field. + * @param string|null $font_family font family for the field * * @return self */ - public function setFontFamily($font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { - throw new \InvalidArgumentException('non-nullable font_family cannot be null'); + throw new InvalidArgumentException('non-nullable font_family cannot be null'); } $allowedValues = $this->getFontFamilyAllowableValues(); if (!in_array($font_family, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'font_family', must be one of '%s'", $font_family, @@ -454,23 +442,22 @@ public function getFontSize() * * @return self */ - public function setFontSize($font_size) + public function setFontSize(?int $font_size) { if (is_null($font_size)) { - throw new \InvalidArgumentException('non-nullable font_size cannot be null'); + throw new InvalidArgumentException('non-nullable font_size cannot be null'); } $this->container['font_size'] = $font_size; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -479,11 +466,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -494,10 +481,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -510,11 +495,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -522,15 +505,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -556,5 +539,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentDropdown.php b/sdks/php/src/Model/SubFormFieldsPerDocumentDropdown.php index baf704962..121c3eb48 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentDropdown.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentDropdown.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentDropdown Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentDropdown extends SubFormFieldsPerDocumentBase @@ -45,58 +44,58 @@ class SubFormFieldsPerDocumentDropdown extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentDropdown'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'options' => 'string[]', 'content' => 'string', 'font_family' => 'string', - 'font_size' => 'int' + 'font_size' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'options' => null, 'content' => null, 'font_family' => null, - 'font_size' => null + 'font_size' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'options' => false, 'content' => false, 'font_family' => false, - 'font_size' => false + 'font_size' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -121,8 +120,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -132,7 +129,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -142,7 +139,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -151,9 +148,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -162,9 +156,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool 'options' => 'options', 'content' => 'content', 'font_family' => 'font_family', - 'font_size' => 'font_size' + 'font_size' => 'font_size', ]; /** @@ -195,7 +186,7 @@ public function isNullableSetToNull(string $property): bool 'options' => 'setOptions', 'content' => 'setContent', 'font_family' => 'setFontFamily', - 'font_size' => 'setFontSize' + 'font_size' => 'setFontSize', ]; /** @@ -208,7 +199,7 @@ public function isNullableSetToNull(string $property): bool 'options' => 'getOptions', 'content' => 'getContent', 'font_family' => 'getFontFamily', - 'font_size' => 'getFontSize' + 'font_size' => 'getFontSize', ]; /** @@ -296,7 +287,6 @@ public function getFontFamilyAllowableValues() ]; } - /** * Constructor * @@ -314,34 +304,33 @@ public function __construct(array $data = null) $this->setIfExists('font_size', $data ?? [], 12); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldsPerDocumentDropdown { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldsPerDocumentDropdown { /** @var SubFormFieldsPerDocumentDropdown */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentDropdown::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -366,7 +355,7 @@ public function listInvalidProperties() if ($this->container['options'] === null) { $invalidProperties[] = "'options' can't be null"; } - if ((count($this->container['options']) < 1)) { + if (count($this->container['options']) < 1) { $invalidProperties[] = "invalid value for 'options', number of items must be greater than or equal to 1."; } @@ -393,7 +382,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -411,10 +399,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -434,19 +422,18 @@ public function getOptions() /** * Sets options * - * @param string[] $options Array of string values representing dropdown values. + * @param string[] $options array of string values representing dropdown values * * @return self */ - public function setOptions($options) + public function setOptions(array $options) { if (is_null($options)) { - throw new \InvalidArgumentException('non-nullable options cannot be null'); + throw new InvalidArgumentException('non-nullable options cannot be null'); } - - if ((count($options) < 1)) { - throw new \InvalidArgumentException('invalid length for $options when calling SubFormFieldsPerDocumentDropdown., number of items must be greater than or equal to 1.'); + if (count($options) < 1) { + throw new InvalidArgumentException('invalid length for $options when calling SubFormFieldsPerDocumentDropdown., number of items must be greater than or equal to 1.'); } $this->container['options'] = $options; @@ -470,10 +457,10 @@ public function getContent() * * @return self */ - public function setContent($content) + public function setContent(?string $content) { if (is_null($content)) { - throw new \InvalidArgumentException('non-nullable content cannot be null'); + throw new InvalidArgumentException('non-nullable content cannot be null'); } $this->container['content'] = $content; @@ -493,18 +480,18 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family Font family for the field. + * @param string|null $font_family font family for the field * * @return self */ - public function setFontFamily($font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { - throw new \InvalidArgumentException('non-nullable font_family cannot be null'); + throw new InvalidArgumentException('non-nullable font_family cannot be null'); } $allowedValues = $this->getFontFamilyAllowableValues(); if (!in_array($font_family, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'font_family', must be one of '%s'", $font_family, @@ -534,23 +521,22 @@ public function getFontSize() * * @return self */ - public function setFontSize($font_size) + public function setFontSize(?int $font_size) { if (is_null($font_size)) { - throw new \InvalidArgumentException('non-nullable font_size cannot be null'); + throw new InvalidArgumentException('non-nullable font_size cannot be null'); } $this->container['font_size'] = $font_size; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -559,11 +545,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -574,10 +560,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -590,11 +574,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -602,15 +584,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -636,5 +618,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentFontEnum.php b/sdks/php/src/Model/SubFormFieldsPerDocumentFontEnum.php index 55b2d0bc3..bc0eff196 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentFontEnum.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentFontEnum.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,12 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentFontEnum Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class SubFormFieldsPerDocumentFontEnum { @@ -97,9 +92,7 @@ public static function getAllowableEnumValues() self::NOTO_SERIF, self::NOTO_CJK_JP_REGULAR, self::NOTO_HEBREW_REGULAR, - self::NOTO_SAN_THAI_MERGED + self::NOTO_SAN_THAI_MERGED, ]; } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentHyperlink.php b/sdks/php/src/Model/SubFormFieldsPerDocumentHyperlink.php index 3ffdf37fc..924429f26 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentHyperlink.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentHyperlink.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentHyperlink Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentHyperlink extends SubFormFieldsPerDocumentBase @@ -45,58 +44,58 @@ class SubFormFieldsPerDocumentHyperlink extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentHyperlink'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'content' => 'string', 'content_url' => 'string', 'font_family' => 'string', - 'font_size' => 'int' + 'font_size' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'content' => null, 'content_url' => null, 'font_family' => null, - 'font_size' => null + 'font_size' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'content' => false, 'content_url' => false, 'font_family' => false, - 'font_size' => false + 'font_size' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -121,8 +120,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -132,7 +129,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -142,7 +139,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -151,9 +148,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -162,9 +156,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool 'content' => 'content', 'content_url' => 'content_url', 'font_family' => 'font_family', - 'font_size' => 'font_size' + 'font_size' => 'font_size', ]; /** @@ -195,7 +186,7 @@ public function isNullableSetToNull(string $property): bool 'content' => 'setContent', 'content_url' => 'setContentUrl', 'font_family' => 'setFontFamily', - 'font_size' => 'setFontSize' + 'font_size' => 'setFontSize', ]; /** @@ -208,7 +199,7 @@ public function isNullableSetToNull(string $property): bool 'content' => 'getContent', 'content_url' => 'getContentUrl', 'font_family' => 'getFontFamily', - 'font_size' => 'getFontSize' + 'font_size' => 'getFontSize', ]; /** @@ -296,7 +287,6 @@ public function getFontFamilyAllowableValues() ]; } - /** * Constructor * @@ -314,34 +304,33 @@ public function __construct(array $data = null) $this->setIfExists('font_size', $data ?? [], 12); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldsPerDocumentHyperlink { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldsPerDocumentHyperlink { /** @var SubFormFieldsPerDocumentHyperlink */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentHyperlink::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -392,7 +381,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -410,10 +398,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -433,14 +421,14 @@ public function getContent() /** * Sets content * - * @param string $content Link Text. + * @param string $content link Text * * @return self */ - public function setContent($content) + public function setContent(string $content) { if (is_null($content)) { - throw new \InvalidArgumentException('non-nullable content cannot be null'); + throw new InvalidArgumentException('non-nullable content cannot be null'); } $this->container['content'] = $content; @@ -460,14 +448,14 @@ public function getContentUrl() /** * Sets content_url * - * @param string $content_url Link URL. + * @param string $content_url link URL * * @return self */ - public function setContentUrl($content_url) + public function setContentUrl(string $content_url) { if (is_null($content_url)) { - throw new \InvalidArgumentException('non-nullable content_url cannot be null'); + throw new InvalidArgumentException('non-nullable content_url cannot be null'); } $this->container['content_url'] = $content_url; @@ -487,18 +475,18 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family Font family for the field. + * @param string|null $font_family font family for the field * * @return self */ - public function setFontFamily($font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { - throw new \InvalidArgumentException('non-nullable font_family cannot be null'); + throw new InvalidArgumentException('non-nullable font_family cannot be null'); } $allowedValues = $this->getFontFamilyAllowableValues(); if (!in_array($font_family, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'font_family', must be one of '%s'", $font_family, @@ -528,23 +516,22 @@ public function getFontSize() * * @return self */ - public function setFontSize($font_size) + public function setFontSize(?int $font_size) { if (is_null($font_size)) { - throw new \InvalidArgumentException('non-nullable font_size cannot be null'); + throw new InvalidArgumentException('non-nullable font_size cannot be null'); } $this->container['font_size'] = $font_size; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -553,11 +540,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -568,10 +555,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -584,11 +569,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -596,15 +579,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -630,5 +613,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentInitials.php b/sdks/php/src/Model/SubFormFieldsPerDocumentInitials.php index 57a576b57..cfddb0495 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentInitials.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentInitials.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentInitials Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentInitials extends SubFormFieldsPerDocumentBase @@ -45,46 +44,46 @@ class SubFormFieldsPerDocumentInitials extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentInitials'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'initials'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldsPerDocumentInitials { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldsPerDocumentInitials { /** @var SubFormFieldsPerDocumentInitials */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentInitials::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentRadio.php b/sdks/php/src/Model/SubFormFieldsPerDocumentRadio.php index 59b12addf..b506baa56 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentRadio.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentRadio.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentRadio Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentRadio extends SubFormFieldsPerDocumentBase @@ -45,52 +44,52 @@ class SubFormFieldsPerDocumentRadio extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentRadio'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'group' => 'string', - 'is_checked' => 'bool' + 'is_checked' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'group' => null, - 'is_checked' => null + 'is_checked' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'group' => false, - 'is_checked' => false + 'is_checked' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,8 +114,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -126,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -136,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -145,9 +142,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -156,9 +150,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -174,7 +165,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'group' => 'group', - 'is_checked' => 'is_checked' + 'is_checked' => 'is_checked', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'group' => 'setGroup', - 'is_checked' => 'setIsChecked' + 'is_checked' => 'setIsChecked', ]; /** @@ -196,7 +187,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'group' => 'getGroup', - 'is_checked' => 'getIsChecked' + 'is_checked' => 'getIsChecked', ]; /** @@ -240,8 +231,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -257,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('is_checked', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldsPerDocumentRadio { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldsPerDocumentRadio { /** @var SubFormFieldsPerDocumentRadio */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentRadio::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -326,7 +314,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -344,10 +331,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -367,14 +354,14 @@ public function getGroup() /** * Sets group * - * @param string $group String referencing group defined in `form_field_groups` parameter. + * @param string $group string referencing group defined in `form_field_groups` parameter * * @return self */ - public function setGroup($group) + public function setGroup(string $group) { if (is_null($group)) { - throw new \InvalidArgumentException('non-nullable group cannot be null'); + throw new InvalidArgumentException('non-nullable group cannot be null'); } $this->container['group'] = $group; @@ -398,23 +385,22 @@ public function getIsChecked() * * @return self */ - public function setIsChecked($is_checked) + public function setIsChecked(bool $is_checked) { if (is_null($is_checked)) { - throw new \InvalidArgumentException('non-nullable is_checked cannot be null'); + throw new InvalidArgumentException('non-nullable is_checked cannot be null'); } $this->container['is_checked'] = $is_checked; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -423,11 +409,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -438,10 +424,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -454,11 +438,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -466,15 +448,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -500,5 +482,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentSignature.php b/sdks/php/src/Model/SubFormFieldsPerDocumentSignature.php index 39b39d14a..37c6e7a15 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentSignature.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentSignature.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentSignature Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentSignature extends SubFormFieldsPerDocumentBase @@ -45,46 +44,46 @@ class SubFormFieldsPerDocumentSignature extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentSignature'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'signature'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldsPerDocumentSignature { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldsPerDocumentSignature { /** @var SubFormFieldsPerDocumentSignature */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentSignature::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentText.php b/sdks/php/src/Model/SubFormFieldsPerDocumentText.php index 2fcedd43f..fa048a12b 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentText.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentText.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentText Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase @@ -45,17 +44,17 @@ class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'placeholder' => 'string', @@ -67,16 +66,16 @@ class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase 'validation_custom_regex_format_label' => 'string', 'content' => 'string', 'font_family' => 'string', - 'font_size' => 'int' + 'font_size' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'placeholder' => null, @@ -88,14 +87,14 @@ class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase 'validation_custom_regex_format_label' => null, 'content' => null, 'font_family' => null, - 'font_size' => null + 'font_size' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'placeholder' => false, @@ -107,14 +106,14 @@ class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase 'validation_custom_regex_format_label' => false, 'content' => false, 'font_family' => false, - 'font_size' => false + 'font_size' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -139,8 +138,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -150,7 +147,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -160,7 +157,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -169,9 +166,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -180,9 +174,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -206,7 +197,7 @@ public function isNullableSetToNull(string $property): bool 'validation_custom_regex_format_label' => 'validation_custom_regex_format_label', 'content' => 'content', 'font_family' => 'font_family', - 'font_size' => 'font_size' + 'font_size' => 'font_size', ]; /** @@ -225,7 +216,7 @@ public function isNullableSetToNull(string $property): bool 'validation_custom_regex_format_label' => 'setValidationCustomRegexFormatLabel', 'content' => 'setContent', 'font_family' => 'setFontFamily', - 'font_size' => 'setFontSize' + 'font_size' => 'setFontSize', ]; /** @@ -244,7 +235,7 @@ public function isNullableSetToNull(string $property): bool 'validation_custom_regex_format_label' => 'getValidationCustomRegexFormatLabel', 'content' => 'getContent', 'font_family' => 'getFontFamily', - 'font_size' => 'getFontSize' + 'font_size' => 'getFontSize', ]; /** @@ -363,7 +354,6 @@ public function getFontFamilyAllowableValues() ]; } - /** * Constructor * @@ -387,34 +377,33 @@ public function __construct(array $data = null) $this->setIfExists('font_size', $data ?? [], 12); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldsPerDocumentText { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldsPerDocumentText { /** @var SubFormFieldsPerDocumentText */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentText::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -468,7 +457,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -486,10 +474,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -509,14 +497,14 @@ public function getPlaceholder() /** * Sets placeholder * - * @param string|null $placeholder Placeholder value for text field. + * @param string|null $placeholder placeholder value for text field * * @return self */ - public function setPlaceholder($placeholder) + public function setPlaceholder(?string $placeholder) { if (is_null($placeholder)) { - throw new \InvalidArgumentException('non-nullable placeholder cannot be null'); + throw new InvalidArgumentException('non-nullable placeholder cannot be null'); } $this->container['placeholder'] = $placeholder; @@ -540,10 +528,10 @@ public function getAutoFillType() * * @return self */ - public function setAutoFillType($auto_fill_type) + public function setAutoFillType(?string $auto_fill_type) { if (is_null($auto_fill_type)) { - throw new \InvalidArgumentException('non-nullable auto_fill_type cannot be null'); + throw new InvalidArgumentException('non-nullable auto_fill_type cannot be null'); } $this->container['auto_fill_type'] = $auto_fill_type; @@ -567,10 +555,10 @@ public function getLinkId() * * @return self */ - public function setLinkId($link_id) + public function setLinkId(?string $link_id) { if (is_null($link_id)) { - throw new \InvalidArgumentException('non-nullable link_id cannot be null'); + throw new InvalidArgumentException('non-nullable link_id cannot be null'); } $this->container['link_id'] = $link_id; @@ -594,10 +582,10 @@ public function getMasked() * * @return self */ - public function setMasked($masked) + public function setMasked(?bool $masked) { if (is_null($masked)) { - throw new \InvalidArgumentException('non-nullable masked cannot be null'); + throw new InvalidArgumentException('non-nullable masked cannot be null'); } $this->container['masked'] = $masked; @@ -621,14 +609,14 @@ public function getValidationType() * * @return self */ - public function setValidationType($validation_type) + public function setValidationType(?string $validation_type) { if (is_null($validation_type)) { - throw new \InvalidArgumentException('non-nullable validation_type cannot be null'); + throw new InvalidArgumentException('non-nullable validation_type cannot be null'); } $allowedValues = $this->getValidationTypeAllowableValues(); if (!in_array($validation_type, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'validation_type', must be one of '%s'", $validation_type, @@ -658,10 +646,10 @@ public function getValidationCustomRegex() * * @return self */ - public function setValidationCustomRegex($validation_custom_regex) + public function setValidationCustomRegex(?string $validation_custom_regex) { if (is_null($validation_custom_regex)) { - throw new \InvalidArgumentException('non-nullable validation_custom_regex cannot be null'); + throw new InvalidArgumentException('non-nullable validation_custom_regex cannot be null'); } $this->container['validation_custom_regex'] = $validation_custom_regex; @@ -685,10 +673,10 @@ public function getValidationCustomRegexFormatLabel() * * @return self */ - public function setValidationCustomRegexFormatLabel($validation_custom_regex_format_label) + public function setValidationCustomRegexFormatLabel(?string $validation_custom_regex_format_label) { if (is_null($validation_custom_regex_format_label)) { - throw new \InvalidArgumentException('non-nullable validation_custom_regex_format_label cannot be null'); + throw new InvalidArgumentException('non-nullable validation_custom_regex_format_label cannot be null'); } $this->container['validation_custom_regex_format_label'] = $validation_custom_regex_format_label; @@ -712,10 +700,10 @@ public function getContent() * * @return self */ - public function setContent($content) + public function setContent(?string $content) { if (is_null($content)) { - throw new \InvalidArgumentException('non-nullable content cannot be null'); + throw new InvalidArgumentException('non-nullable content cannot be null'); } $this->container['content'] = $content; @@ -735,18 +723,18 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family Font family for the field. + * @param string|null $font_family font family for the field * * @return self */ - public function setFontFamily($font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { - throw new \InvalidArgumentException('non-nullable font_family cannot be null'); + throw new InvalidArgumentException('non-nullable font_family cannot be null'); } $allowedValues = $this->getFontFamilyAllowableValues(); if (!in_array($font_family, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'font_family', must be one of '%s'", $font_family, @@ -776,23 +764,22 @@ public function getFontSize() * * @return self */ - public function setFontSize($font_size) + public function setFontSize(?int $font_size) { if (is_null($font_size)) { - throw new \InvalidArgumentException('non-nullable font_size cannot be null'); + throw new InvalidArgumentException('non-nullable font_size cannot be null'); } $this->container['font_size'] = $font_size; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -801,11 +788,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -816,10 +803,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -832,11 +817,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -844,15 +827,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -878,5 +861,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php b/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php index ead5e94b7..bfe22420e 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * SubFormFieldsPerDocumentTextMerge Class Doc Comment * * @category Class * @description This class extends `SubFormFieldsPerDocumentBase`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class SubFormFieldsPerDocumentTextMerge extends SubFormFieldsPerDocumentBase @@ -45,52 +44,52 @@ class SubFormFieldsPerDocumentTextMerge extends SubFormFieldsPerDocumentBase public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubFormFieldsPerDocumentTextMerge'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'font_family' => 'string', - 'font_size' => 'int' + 'font_size' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'font_family' => null, - 'font_size' => null + 'font_size' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'font_family' => false, - 'font_size' => false + 'font_size' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -115,8 +114,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -126,7 +123,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -136,7 +133,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -145,9 +142,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -156,9 +150,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -174,7 +165,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'type' => 'type', 'font_family' => 'font_family', - 'font_size' => 'font_size' + 'font_size' => 'font_size', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'type' => 'setType', 'font_family' => 'setFontFamily', - 'font_size' => 'setFontSize' + 'font_size' => 'setFontSize', ]; /** @@ -196,7 +187,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'type' => 'getType', 'font_family' => 'getFontFamily', - 'font_size' => 'getFontSize' + 'font_size' => 'getFontSize', ]; /** @@ -284,7 +275,6 @@ public function getFontFamilyAllowableValues() ]; } - /** * Constructor * @@ -300,34 +290,33 @@ public function __construct(array $data = null) $this->setIfExists('font_size', $data ?? [], 12); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubFormFieldsPerDocumentTextMerge { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubFormFieldsPerDocumentTextMerge { /** @var SubFormFieldsPerDocumentTextMerge */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubFormFieldsPerDocumentTextMerge::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -372,7 +361,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -390,10 +378,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -413,18 +401,18 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family Font family for the field. + * @param string|null $font_family font family for the field * * @return self */ - public function setFontFamily($font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { - throw new \InvalidArgumentException('non-nullable font_family cannot be null'); + throw new InvalidArgumentException('non-nullable font_family cannot be null'); } $allowedValues = $this->getFontFamilyAllowableValues(); if (!in_array($font_family, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'font_family', must be one of '%s'", $font_family, @@ -454,23 +442,22 @@ public function getFontSize() * * @return self */ - public function setFontSize($font_size) + public function setFontSize(?int $font_size) { if (is_null($font_size)) { - throw new \InvalidArgumentException('non-nullable font_size cannot be null'); + throw new InvalidArgumentException('non-nullable font_size cannot be null'); } $this->container['font_size'] = $font_size; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -479,11 +466,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -494,10 +481,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -510,11 +495,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -522,15 +505,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -556,5 +539,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentTypeEnum.php b/sdks/php/src/Model/SubFormFieldsPerDocumentTypeEnum.php index 90cbd6110..4a4294f5e 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentTypeEnum.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentTypeEnum.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,15 +26,12 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; /** * SubFormFieldsPerDocumentTypeEnum Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class SubFormFieldsPerDocumentTypeEnum { @@ -79,9 +74,7 @@ public static function getAllowableEnumValues() self::SIGNATURE, self::RADIO, self::TEXT, - self::TEXT_MERGE + self::TEXT_MERGE, ]; } } - - diff --git a/sdks/php/src/Model/SubMergeField.php b/sdks/php/src/Model/SubMergeField.php index 8afe90857..8631a07e4 100644 --- a/sdks/php/src/Model/SubMergeField.php +++ b/sdks/php/src/Model/SubMergeField.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubMergeField Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubMergeField implements ModelInterface, ArrayAccess, \JsonSerializable +class SubMergeField implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubMergeField'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'name' => false, - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'type' => 'type' + 'type' => 'type', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -270,34 +261,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubMergeField { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubMergeField { /** @var SubMergeField */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubMergeField::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -345,7 +335,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -363,10 +352,10 @@ public function getName() * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -386,18 +375,18 @@ public function getType() /** * Sets type * - * @param string $type The type of merge field. + * @param string $type the type of merge field * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'type', must be one of '%s'", $type, @@ -409,14 +398,13 @@ public function setType($type) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -425,11 +413,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -440,10 +428,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -456,11 +442,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -468,15 +452,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -502,5 +486,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubOAuth.php b/sdks/php/src/Model/SubOAuth.php index 1448e8c42..2bbf85547 100644 --- a/sdks/php/src/Model/SubOAuth.php +++ b/sdks/php/src/Model/SubOAuth.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,67 +27,68 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubOAuth Class Doc Comment * * @category Class * @description OAuth related parameters. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubOAuth implements ModelInterface, ArrayAccess, \JsonSerializable +class SubOAuth implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubOAuth'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'callback_url' => 'string', - 'scopes' => 'string[]' + 'scopes' => 'string[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'callback_url' => null, - 'scopes' => null + 'scopes' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'callback_url' => false, - 'scopes' => false + 'scopes' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -172,7 +163,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'callback_url' => 'callback_url', - 'scopes' => 'scopes' + 'scopes' => 'scopes', ]; /** @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'callback_url' => 'setCallbackUrl', - 'scopes' => 'setScopes' + 'scopes' => 'setScopes', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'callback_url' => 'getCallbackUrl', - 'scopes' => 'getScopes' + 'scopes' => 'getScopes', ]; /** @@ -283,34 +274,33 @@ public function __construct(array $data = null) $this->setIfExists('scopes', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubOAuth { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubOAuth { /** @var SubOAuth */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubOAuth::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -327,9 +317,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -343,7 +331,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets callback_url * @@ -361,10 +348,10 @@ public function getCallbackUrl() * * @return self */ - public function setCallbackUrl($callback_url) + public function setCallbackUrl(?string $callback_url) { if (is_null($callback_url)) { - throw new \InvalidArgumentException('non-nullable callback_url cannot be null'); + throw new InvalidArgumentException('non-nullable callback_url cannot be null'); } $this->container['callback_url'] = $callback_url; @@ -388,14 +375,14 @@ public function getScopes() * * @return self */ - public function setScopes($scopes) + public function setScopes(?array $scopes) { if (is_null($scopes)) { - throw new \InvalidArgumentException('non-nullable scopes cannot be null'); + throw new InvalidArgumentException('non-nullable scopes cannot be null'); } $allowedValues = $this->getScopesAllowableValues(); if (array_diff($scopes, $allowedValues)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value for 'scopes', must be one of '%s'", implode("', '", $allowedValues) @@ -406,14 +393,13 @@ public function setScopes($scopes) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -422,11 +408,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -437,10 +423,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -453,11 +437,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -465,15 +447,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -499,5 +481,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubOptions.php b/sdks/php/src/Model/SubOptions.php index 13bfa09ef..b86fa5b7f 100644 --- a/sdks/php/src/Model/SubOptions.php +++ b/sdks/php/src/Model/SubOptions.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,64 +27,65 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubOptions Class Doc Comment * * @category Class * @description Additional options supported by API App. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubOptions implements ModelInterface, ArrayAccess, \JsonSerializable +class SubOptions implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'can_insert_everywhere' => 'bool' + 'can_insert_everywhere' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'can_insert_everywhere' => null + 'can_insert_everywhere' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'can_insert_everywhere' => false + 'can_insert_everywhere' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -168,7 +159,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'can_insert_everywhere' => 'can_insert_everywhere' + 'can_insert_everywhere' => 'can_insert_everywhere', ]; /** @@ -177,7 +168,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'can_insert_everywhere' => 'setCanInsertEverywhere' + 'can_insert_everywhere' => 'setCanInsertEverywhere', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'can_insert_everywhere' => 'getCanInsertEverywhere' + 'can_insert_everywhere' => 'getCanInsertEverywhere', ]; /** @@ -230,7 +221,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -249,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('can_insert_everywhere', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubOptions { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubOptions { /** @var SubOptions */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubOptions::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +282,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -309,7 +296,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets can_insert_everywhere * @@ -323,27 +309,26 @@ public function getCanInsertEverywhere() /** * Sets can_insert_everywhere * - * @param bool|null $can_insert_everywhere Determines if signers can use \"Insert Everywhere\" when signing a document. + * @param bool|null $can_insert_everywhere determines if signers can use \"Insert Everywhere\" when signing a document * * @return self */ - public function setCanInsertEverywhere($can_insert_everywhere) + public function setCanInsertEverywhere(?bool $can_insert_everywhere) { if (is_null($can_insert_everywhere)) { - throw new \InvalidArgumentException('non-nullable can_insert_everywhere cannot be null'); + throw new InvalidArgumentException('non-nullable can_insert_everywhere cannot be null'); } $this->container['can_insert_everywhere'] = $can_insert_everywhere; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -352,11 +337,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -367,10 +352,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -383,11 +366,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -395,15 +376,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -429,5 +410,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php b/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php index 160375e08..2d15bc241 100644 --- a/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php +++ b/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubSignatureRequestGroupedSigners Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubSignatureRequestGroupedSigners implements ModelInterface, ArrayAccess, \JsonSerializable +class SubSignatureRequestGroupedSigners implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubSignatureRequestGroupedSigners'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'group' => 'string', 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestSigner[]', - 'order' => 'int' + 'order' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'group' => null, 'signers' => null, - 'order' => null + 'order' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'group' => false, 'signers' => false, - 'order' => true + 'order' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'group' => 'group', 'signers' => 'signers', - 'order' => 'order' + 'order' => 'order', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'group' => 'setGroup', 'signers' => 'setSigners', - 'order' => 'setOrder' + 'order' => 'setOrder', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'group' => 'getGroup', 'signers' => 'getSigners', - 'order' => 'getOrder' + 'order' => 'getOrder', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('order', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubSignatureRequestGroupedSigners { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubSignatureRequestGroupedSigners { /** @var SubSignatureRequestGroupedSigners */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubSignatureRequestGroupedSigners::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,7 +317,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets group * @@ -342,14 +330,14 @@ public function getGroup() /** * Sets group * - * @param string $group The name of the group. + * @param string $group the name of the group * * @return self */ - public function setGroup($group) + public function setGroup(string $group) { if (is_null($group)) { - throw new \InvalidArgumentException('non-nullable group cannot be null'); + throw new InvalidArgumentException('non-nullable group cannot be null'); } $this->container['group'] = $group; @@ -359,7 +347,7 @@ public function setGroup($group) /** * Gets signers * - * @return \Dropbox\Sign\Model\SubSignatureRequestSigner[] + * @return SubSignatureRequestSigner[] */ public function getSigners() { @@ -369,14 +357,14 @@ public function getSigners() /** * Sets signers * - * @param \Dropbox\Sign\Model\SubSignatureRequestSigner[] $signers Signers belonging to this Group. **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. + * @param SubSignatureRequestSigner[] $signers Signers belonging to this Group. **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. * * @return self */ - public function setSigners($signers) + public function setSigners(array $signers) { if (is_null($signers)) { - throw new \InvalidArgumentException('non-nullable signers cannot be null'); + throw new InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -400,14 +388,14 @@ public function getOrder() * * @return self */ - public function setOrder($order) + public function setOrder(?int $order) { if (is_null($order)) { array_push($this->openAPINullablesSetToNull, 'order'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('order', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -416,14 +404,13 @@ public function setOrder($order) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -432,11 +419,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -447,10 +434,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -463,11 +448,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -475,15 +458,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -509,5 +492,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubSignatureRequestSigner.php b/sdks/php/src/Model/SubSignatureRequestSigner.php index 94129127a..64133e165 100644 --- a/sdks/php/src/Model/SubSignatureRequestSigner.php +++ b/sdks/php/src/Model/SubSignatureRequestSigner.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,78 +27,79 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubSignatureRequestSigner Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubSignatureRequestSigner implements ModelInterface, ArrayAccess, \JsonSerializable +class SubSignatureRequestSigner implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubSignatureRequestSigner'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', 'email_address' => 'string', 'order' => 'int', 'pin' => 'string', 'sms_phone_number' => 'string', - 'sms_phone_number_type' => 'string' + 'sms_phone_number_type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, 'email_address' => 'email', 'order' => null, 'pin' => null, 'sms_phone_number' => null, - 'sms_phone_number_type' => null + 'sms_phone_number_type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'name' => false, 'email_address' => false, 'order' => true, 'pin' => false, 'sms_phone_number' => false, - 'sms_phone_number_type' => false + 'sms_phone_number_type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -125,8 +124,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -136,7 +133,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -146,7 +143,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -155,9 +152,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -166,9 +160,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -187,7 +178,7 @@ public function isNullableSetToNull(string $property): bool 'order' => 'order', 'pin' => 'pin', 'sms_phone_number' => 'sms_phone_number', - 'sms_phone_number_type' => 'sms_phone_number_type' + 'sms_phone_number_type' => 'sms_phone_number_type', ]; /** @@ -201,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'order' => 'setOrder', 'pin' => 'setPin', 'sms_phone_number' => 'setSmsPhoneNumber', - 'sms_phone_number_type' => 'setSmsPhoneNumberType' + 'sms_phone_number_type' => 'setSmsPhoneNumberType', ]; /** @@ -215,7 +206,7 @@ public function isNullableSetToNull(string $property): bool 'order' => 'getOrder', 'pin' => 'getPin', 'sms_phone_number' => 'getSmsPhoneNumber', - 'sms_phone_number_type' => 'getSmsPhoneNumberType' + 'sms_phone_number_type' => 'getSmsPhoneNumberType', ]; /** @@ -298,34 +289,33 @@ public function __construct(array $data = null) $this->setIfExists('sms_phone_number_type', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubSignatureRequestSigner { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubSignatureRequestSigner { /** @var SubSignatureRequestSigner */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubSignatureRequestSigner::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -381,7 +371,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -395,14 +384,14 @@ public function getName() /** * Sets name * - * @param string $name The name of the signer. + * @param string $name the name of the signer * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -422,14 +411,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address The email address of the signer. + * @param string $email_address the email address of the signer * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -449,18 +438,18 @@ public function getOrder() /** * Sets order * - * @param int|null $order The order the signer is required to sign in. + * @param int|null $order the order the signer is required to sign in * * @return self */ - public function setOrder($order) + public function setOrder(?int $order) { if (is_null($order)) { array_push($this->openAPINullablesSetToNull, 'order'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('order', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -483,20 +472,20 @@ public function getPin() /** * Sets pin * - * @param string|null $pin The 4- to 12-character access code that will secure this signer's signature page. + * @param string|null $pin the 4- to 12-character access code that will secure this signer's signature page * * @return self */ - public function setPin($pin) + public function setPin(?string $pin) { if (is_null($pin)) { - throw new \InvalidArgumentException('non-nullable pin cannot be null'); + throw new InvalidArgumentException('non-nullable pin cannot be null'); } - if ((mb_strlen($pin) > 12)) { - throw new \InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestSigner., must be smaller than or equal to 12.'); + if (mb_strlen($pin) > 12) { + throw new InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestSigner., must be smaller than or equal to 12.'); } - if ((mb_strlen($pin) < 4)) { - throw new \InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestSigner., must be bigger than or equal to 4.'); + if (mb_strlen($pin) < 4) { + throw new InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestSigner., must be bigger than or equal to 4.'); } $this->container['pin'] = $pin; @@ -521,10 +510,10 @@ public function getSmsPhoneNumber() * * @return self */ - public function setSmsPhoneNumber($sms_phone_number) + public function setSmsPhoneNumber(?string $sms_phone_number) { if (is_null($sms_phone_number)) { - throw new \InvalidArgumentException('non-nullable sms_phone_number cannot be null'); + throw new InvalidArgumentException('non-nullable sms_phone_number cannot be null'); } $this->container['sms_phone_number'] = $sms_phone_number; @@ -548,14 +537,14 @@ public function getSmsPhoneNumberType() * * @return self */ - public function setSmsPhoneNumberType($sms_phone_number_type) + public function setSmsPhoneNumberType(?string $sms_phone_number_type) { if (is_null($sms_phone_number_type)) { - throw new \InvalidArgumentException('non-nullable sms_phone_number_type cannot be null'); + throw new InvalidArgumentException('non-nullable sms_phone_number_type cannot be null'); } $allowedValues = $this->getSmsPhoneNumberTypeAllowableValues(); if (!in_array($sms_phone_number_type, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'sms_phone_number_type', must be one of '%s'", $sms_phone_number_type, @@ -567,14 +556,13 @@ public function setSmsPhoneNumberType($sms_phone_number_type) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -583,11 +571,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -598,10 +586,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -614,11 +600,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -626,15 +610,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -660,5 +644,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php b/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php index c642cd421..15070e31f 100644 --- a/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php +++ b/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,78 +27,79 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubSignatureRequestTemplateSigner Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubSignatureRequestTemplateSigner implements ModelInterface, ArrayAccess, \JsonSerializable +class SubSignatureRequestTemplateSigner implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubSignatureRequestTemplateSigner'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'role' => 'string', 'name' => 'string', 'email_address' => 'string', 'pin' => 'string', 'sms_phone_number' => 'string', - 'sms_phone_number_type' => 'string' + 'sms_phone_number_type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'role' => null, 'name' => null, 'email_address' => 'email', 'pin' => null, 'sms_phone_number' => null, - 'sms_phone_number_type' => null + 'sms_phone_number_type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'role' => false, 'name' => false, 'email_address' => false, 'pin' => false, 'sms_phone_number' => false, - 'sms_phone_number_type' => false + 'sms_phone_number_type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -125,8 +124,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -136,7 +133,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -146,7 +143,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -155,9 +152,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -166,9 +160,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -187,7 +178,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'email_address', 'pin' => 'pin', 'sms_phone_number' => 'sms_phone_number', - 'sms_phone_number_type' => 'sms_phone_number_type' + 'sms_phone_number_type' => 'sms_phone_number_type', ]; /** @@ -201,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'setEmailAddress', 'pin' => 'setPin', 'sms_phone_number' => 'setSmsPhoneNumber', - 'sms_phone_number_type' => 'setSmsPhoneNumberType' + 'sms_phone_number_type' => 'setSmsPhoneNumberType', ]; /** @@ -215,7 +206,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'getEmailAddress', 'pin' => 'getPin', 'sms_phone_number' => 'getSmsPhoneNumber', - 'sms_phone_number_type' => 'getSmsPhoneNumberType' + 'sms_phone_number_type' => 'getSmsPhoneNumberType', ]; /** @@ -298,34 +289,33 @@ public function __construct(array $data = null) $this->setIfExists('sms_phone_number_type', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubSignatureRequestTemplateSigner { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubSignatureRequestTemplateSigner { /** @var SubSignatureRequestTemplateSigner */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubSignatureRequestTemplateSigner::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -384,7 +374,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets role * @@ -402,10 +391,10 @@ public function getRole() * * @return self */ - public function setRole($role) + public function setRole(string $role) { if (is_null($role)) { - throw new \InvalidArgumentException('non-nullable role cannot be null'); + throw new InvalidArgumentException('non-nullable role cannot be null'); } $this->container['role'] = $role; @@ -425,14 +414,14 @@ public function getName() /** * Sets name * - * @param string $name The name of the signer. + * @param string $name the name of the signer * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -452,14 +441,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address The email address of the signer. + * @param string $email_address the email address of the signer * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -479,20 +468,20 @@ public function getPin() /** * Sets pin * - * @param string|null $pin The 4- to 12-character access code that will secure this signer's signature page. + * @param string|null $pin the 4- to 12-character access code that will secure this signer's signature page * * @return self */ - public function setPin($pin) + public function setPin(?string $pin) { if (is_null($pin)) { - throw new \InvalidArgumentException('non-nullable pin cannot be null'); + throw new InvalidArgumentException('non-nullable pin cannot be null'); } - if ((mb_strlen($pin) > 12)) { - throw new \InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestTemplateSigner., must be smaller than or equal to 12.'); + if (mb_strlen($pin) > 12) { + throw new InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestTemplateSigner., must be smaller than or equal to 12.'); } - if ((mb_strlen($pin) < 4)) { - throw new \InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestTemplateSigner., must be bigger than or equal to 4.'); + if (mb_strlen($pin) < 4) { + throw new InvalidArgumentException('invalid length for $pin when calling SubSignatureRequestTemplateSigner., must be bigger than or equal to 4.'); } $this->container['pin'] = $pin; @@ -517,10 +506,10 @@ public function getSmsPhoneNumber() * * @return self */ - public function setSmsPhoneNumber($sms_phone_number) + public function setSmsPhoneNumber(?string $sms_phone_number) { if (is_null($sms_phone_number)) { - throw new \InvalidArgumentException('non-nullable sms_phone_number cannot be null'); + throw new InvalidArgumentException('non-nullable sms_phone_number cannot be null'); } $this->container['sms_phone_number'] = $sms_phone_number; @@ -544,14 +533,14 @@ public function getSmsPhoneNumberType() * * @return self */ - public function setSmsPhoneNumberType($sms_phone_number_type) + public function setSmsPhoneNumberType(?string $sms_phone_number_type) { if (is_null($sms_phone_number_type)) { - throw new \InvalidArgumentException('non-nullable sms_phone_number_type cannot be null'); + throw new InvalidArgumentException('non-nullable sms_phone_number_type cannot be null'); } $allowedValues = $this->getSmsPhoneNumberTypeAllowableValues(); if (!in_array($sms_phone_number_type, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'sms_phone_number_type', must be one of '%s'", $sms_phone_number_type, @@ -563,14 +552,13 @@ public function setSmsPhoneNumberType($sms_phone_number_type) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -579,11 +567,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -594,10 +582,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -610,11 +596,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -622,15 +606,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -656,5 +640,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubSigningOptions.php b/sdks/php/src/Model/SubSigningOptions.php index 24a75fd04..8cbaff0f0 100644 --- a/sdks/php/src/Model/SubSigningOptions.php +++ b/sdks/php/src/Model/SubSigningOptions.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,76 +27,77 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubSigningOptions Class Doc Comment * * @category Class * @description This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubSigningOptions implements ModelInterface, ArrayAccess, \JsonSerializable +class SubSigningOptions implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubSigningOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'default_type' => 'string', 'draw' => 'bool', 'phone' => 'bool', 'type' => 'bool', - 'upload' => 'bool' + 'upload' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'default_type' => null, 'draw' => null, 'phone' => null, 'type' => null, - 'upload' => null + 'upload' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'default_type' => false, 'draw' => false, 'phone' => false, 'type' => false, - 'upload' => false + 'upload' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -123,8 +122,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -134,7 +131,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -144,7 +141,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -153,9 +150,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -164,9 +158,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool 'draw' => 'draw', 'phone' => 'phone', 'type' => 'type', - 'upload' => 'upload' + 'upload' => 'upload', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool 'draw' => 'setDraw', 'phone' => 'setPhone', 'type' => 'setType', - 'upload' => 'setUpload' + 'upload' => 'setUpload', ]; /** @@ -210,7 +201,7 @@ public function isNullableSetToNull(string $property): bool 'draw' => 'getDraw', 'phone' => 'getPhone', 'type' => 'getType', - 'upload' => 'getUpload' + 'upload' => 'getUpload', ]; /** @@ -296,34 +287,33 @@ public function __construct(array $data = null) $this->setIfExists('upload', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubSigningOptions { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubSigningOptions { /** @var SubSigningOptions */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubSigningOptions::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -368,7 +358,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets default_type * @@ -386,14 +375,14 @@ public function getDefaultType() * * @return self */ - public function setDefaultType($default_type) + public function setDefaultType(string $default_type) { if (is_null($default_type)) { - throw new \InvalidArgumentException('non-nullable default_type cannot be null'); + throw new InvalidArgumentException('non-nullable default_type cannot be null'); } $allowedValues = $this->getDefaultTypeAllowableValues(); if (!in_array($default_type, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'default_type', must be one of '%s'", $default_type, @@ -423,10 +412,10 @@ public function getDraw() * * @return self */ - public function setDraw($draw) + public function setDraw(?bool $draw) { if (is_null($draw)) { - throw new \InvalidArgumentException('non-nullable draw cannot be null'); + throw new InvalidArgumentException('non-nullable draw cannot be null'); } $this->container['draw'] = $draw; @@ -450,10 +439,10 @@ public function getPhone() * * @return self */ - public function setPhone($phone) + public function setPhone(?bool $phone) { if (is_null($phone)) { - throw new \InvalidArgumentException('non-nullable phone cannot be null'); + throw new InvalidArgumentException('non-nullable phone cannot be null'); } $this->container['phone'] = $phone; @@ -477,10 +466,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?bool $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -504,23 +493,22 @@ public function getUpload() * * @return self */ - public function setUpload($upload) + public function setUpload(?bool $upload) { if (is_null($upload)) { - throw new \InvalidArgumentException('non-nullable upload cannot be null'); + throw new InvalidArgumentException('non-nullable upload cannot be null'); } $this->container['upload'] = $upload; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -529,11 +517,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -544,10 +532,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -560,11 +546,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -572,15 +556,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -606,5 +590,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubTeamResponse.php b/sdks/php/src/Model/SubTeamResponse.php index 30f1dbae8..60ecc442a 100644 --- a/sdks/php/src/Model/SubTeamResponse.php +++ b/sdks/php/src/Model/SubTeamResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubTeamResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubTeamResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class SubTeamResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubTeamResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team_id' => 'string', - 'name' => 'string' + 'name' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team_id' => null, - 'name' => null + 'name' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'team_id' => false, - 'name' => false + 'name' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'team_id' => 'team_id', - 'name' => 'name' + 'name' => 'name', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'team_id' => 'setTeamId', - 'name' => 'setName' + 'name' => 'setName', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'team_id' => 'getTeamId', - 'name' => 'getName' + 'name' => 'getName', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubTeamResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubTeamResponse { /** @var SubTeamResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubTeamResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -299,9 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -315,7 +302,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets team_id * @@ -333,10 +319,10 @@ public function getTeamId() * * @return self */ - public function setTeamId($team_id) + public function setTeamId(?string $team_id) { if (is_null($team_id)) { - throw new \InvalidArgumentException('non-nullable team_id cannot be null'); + throw new InvalidArgumentException('non-nullable team_id cannot be null'); } $this->container['team_id'] = $team_id; @@ -360,23 +346,22 @@ public function getName() * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -385,11 +370,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -400,10 +385,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -416,11 +399,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -428,15 +409,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -462,5 +443,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubTemplateRole.php b/sdks/php/src/Model/SubTemplateRole.php index 53d37b44d..2678da93a 100644 --- a/sdks/php/src/Model/SubTemplateRole.php +++ b/sdks/php/src/Model/SubTemplateRole.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubTemplateRole Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubTemplateRole implements ModelInterface, ArrayAccess, \JsonSerializable +class SubTemplateRole implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubTemplateRole'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', - 'order' => 'int' + 'order' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, - 'order' => null + 'order' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'name' => false, - 'order' => true + 'order' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'order' => 'order' + 'order' => 'order', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'order' => 'setOrder' + 'order' => 'setOrder', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'order' => 'getOrder' + 'order' => 'getOrder', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('order', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubTemplateRole { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubTemplateRole { /** @var SubTemplateRole */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubTemplateRole::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -299,9 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -315,7 +302,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -329,14 +315,14 @@ public function getName() /** * Sets name * - * @param string|null $name The role name of the signer that will be displayed when the template is used to create a signature request. + * @param string|null $name the role name of the signer that will be displayed when the template is used to create a signature request * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -356,18 +342,18 @@ public function getOrder() /** * Sets order * - * @param int|null $order The order in which this signer role is required to sign. + * @param int|null $order the order in which this signer role is required to sign * * @return self */ - public function setOrder($order) + public function setOrder(?int $order) { if (is_null($order)) { array_push($this->openAPINullablesSetToNull, 'order'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('order', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -376,14 +362,13 @@ public function setOrder($order) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -392,11 +377,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -407,10 +392,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -423,11 +406,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -435,15 +416,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -469,5 +450,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubUnclaimedDraftSigner.php b/sdks/php/src/Model/SubUnclaimedDraftSigner.php index aa2a1995a..acc466356 100644 --- a/sdks/php/src/Model/SubUnclaimedDraftSigner.php +++ b/sdks/php/src/Model/SubUnclaimedDraftSigner.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubUnclaimedDraftSigner Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubUnclaimedDraftSigner implements ModelInterface, ArrayAccess, \JsonSerializable +class SubUnclaimedDraftSigner implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubUnclaimedDraftSigner'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'email_address' => 'string', 'name' => 'string', - 'order' => 'int' + 'order' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'email_address' => 'email', 'name' => null, - 'order' => null + 'order' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'email_address' => false, 'name' => false, - 'order' => true + 'order' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'email_address' => 'email_address', 'name' => 'name', - 'order' => 'order' + 'order' => 'order', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'email_address' => 'setEmailAddress', 'name' => 'setName', - 'order' => 'setOrder' + 'order' => 'setOrder', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'email_address' => 'getEmailAddress', 'name' => 'getName', - 'order' => 'getOrder' + 'order' => 'getOrder', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('order', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubUnclaimedDraftSigner { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubUnclaimedDraftSigner { /** @var SubUnclaimedDraftSigner */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubUnclaimedDraftSigner::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,7 +317,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets email_address * @@ -342,14 +330,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address The email address of the signer. + * @param string $email_address the email address of the signer * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -369,14 +357,14 @@ public function getName() /** * Sets name * - * @param string $name The name of the signer. + * @param string $name the name of the signer * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -396,18 +384,18 @@ public function getOrder() /** * Sets order * - * @param int|null $order The order the signer is required to sign in. + * @param int|null $order the order the signer is required to sign in * * @return self */ - public function setOrder($order) + public function setOrder(?int $order) { if (is_null($order)) { array_push($this->openAPINullablesSetToNull, 'order'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('order', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -416,14 +404,13 @@ public function setOrder($order) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -432,11 +419,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -447,10 +434,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -463,11 +448,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -475,15 +458,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -509,5 +492,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php b/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php index ee8818c41..9daffb1e4 100644 --- a/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php +++ b/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubUnclaimedDraftTemplateSigner Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubUnclaimedDraftTemplateSigner implements ModelInterface, ArrayAccess, \JsonSerializable +class SubUnclaimedDraftTemplateSigner implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubUnclaimedDraftTemplateSigner'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'role' => 'string', 'name' => 'string', - 'email_address' => 'string' + 'email_address' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'role' => null, 'name' => null, - 'email_address' => 'email' + 'email_address' => 'email', ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'role' => false, 'name' => false, - 'email_address' => false + 'email_address' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'role' => 'role', 'name' => 'name', - 'email_address' => 'email_address' + 'email_address' => 'email_address', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'role' => 'setRole', 'name' => 'setName', - 'email_address' => 'setEmailAddress' + 'email_address' => 'setEmailAddress', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'role' => 'getRole', 'name' => 'getName', - 'email_address' => 'getEmailAddress' + 'email_address' => 'getEmailAddress', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubUnclaimedDraftTemplateSigner { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubUnclaimedDraftTemplateSigner { /** @var SubUnclaimedDraftTemplateSigner */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubUnclaimedDraftTemplateSigner::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -331,7 +320,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets role * @@ -345,14 +333,14 @@ public function getRole() /** * Sets role * - * @param string $role Must match an existing role in chosen Template(s). + * @param string $role must match an existing role in chosen Template(s) * * @return self */ - public function setRole($role) + public function setRole(string $role) { if (is_null($role)) { - throw new \InvalidArgumentException('non-nullable role cannot be null'); + throw new InvalidArgumentException('non-nullable role cannot be null'); } $this->container['role'] = $role; @@ -372,14 +360,14 @@ public function getName() /** * Sets name * - * @param string $name The name of the signer filling the role of `role`. + * @param string $name the name of the signer filling the role of `role` * * @return self */ - public function setName($name) + public function setName(string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -399,27 +387,26 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address The email address of the signer filling the role of `role`. + * @param string $email_address the email address of the signer filling the role of `role` * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -428,11 +415,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -443,10 +430,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -459,11 +444,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -471,15 +454,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -505,5 +488,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/SubWhiteLabelingOptions.php b/sdks/php/src/Model/SubWhiteLabelingOptions.php index d088f98cd..0abcbd111 100644 --- a/sdks/php/src/Model/SubWhiteLabelingOptions.php +++ b/sdks/php/src/Model/SubWhiteLabelingOptions.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * SubWhiteLabelingOptions Class Doc Comment * * @category Class * @description An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class SubWhiteLabelingOptions implements ModelInterface, ArrayAccess, \JsonSerializable +class SubWhiteLabelingOptions implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'SubWhiteLabelingOptions'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'header_background_color' => 'string', 'legal_version' => 'string', @@ -73,16 +72,16 @@ class SubWhiteLabelingOptions implements ModelInterface, ArrayAccess, \JsonSeria 'secondary_button_text_color_hover' => 'string', 'text_color1' => 'string', 'text_color2' => 'string', - 'reset_to_default' => 'bool' + 'reset_to_default' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'header_background_color' => null, 'legal_version' => null, @@ -98,14 +97,14 @@ class SubWhiteLabelingOptions implements ModelInterface, ArrayAccess, \JsonSeria 'secondary_button_text_color_hover' => null, 'text_color1' => null, 'text_color2' => null, - 'reset_to_default' => null + 'reset_to_default' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'header_background_color' => false, 'legal_version' => false, @@ -121,14 +120,14 @@ class SubWhiteLabelingOptions implements ModelInterface, ArrayAccess, \JsonSeria 'secondary_button_text_color_hover' => false, 'text_color1' => false, 'text_color2' => false, - 'reset_to_default' => false + 'reset_to_default' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -153,8 +152,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -164,7 +161,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -174,7 +171,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -183,9 +180,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -194,9 +188,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -224,7 +215,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color_hover' => 'secondary_button_text_color_hover', 'text_color1' => 'text_color1', 'text_color2' => 'text_color2', - 'reset_to_default' => 'reset_to_default' + 'reset_to_default' => 'reset_to_default', ]; /** @@ -247,7 +238,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color_hover' => 'setSecondaryButtonTextColorHover', 'text_color1' => 'setTextColor1', 'text_color2' => 'setTextColor2', - 'reset_to_default' => 'setResetToDefault' + 'reset_to_default' => 'setResetToDefault', ]; /** @@ -270,7 +261,7 @@ public function isNullableSetToNull(string $property): bool 'secondary_button_text_color_hover' => 'getSecondaryButtonTextColorHover', 'text_color1' => 'getTextColor1', 'text_color2' => 'getTextColor2', - 'reset_to_default' => 'getResetToDefault' + 'reset_to_default' => 'getResetToDefault', ]; /** @@ -362,34 +353,33 @@ public function __construct(array $data = null) $this->setIfExists('reset_to_default', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): SubWhiteLabelingOptions { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): SubWhiteLabelingOptions { /** @var SubWhiteLabelingOptions */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, SubWhiteLabelingOptions::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -431,7 +421,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets header_background_color * @@ -449,10 +438,10 @@ public function getHeaderBackgroundColor() * * @return self */ - public function setHeaderBackgroundColor($header_background_color) + public function setHeaderBackgroundColor(?string $header_background_color) { if (is_null($header_background_color)) { - throw new \InvalidArgumentException('non-nullable header_background_color cannot be null'); + throw new InvalidArgumentException('non-nullable header_background_color cannot be null'); } $this->container['header_background_color'] = $header_background_color; @@ -476,14 +465,14 @@ public function getLegalVersion() * * @return self */ - public function setLegalVersion($legal_version) + public function setLegalVersion(?string $legal_version) { if (is_null($legal_version)) { - throw new \InvalidArgumentException('non-nullable legal_version cannot be null'); + throw new InvalidArgumentException('non-nullable legal_version cannot be null'); } $allowedValues = $this->getLegalVersionAllowableValues(); if (!in_array($legal_version, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'legal_version', must be one of '%s'", $legal_version, @@ -513,10 +502,10 @@ public function getLinkColor() * * @return self */ - public function setLinkColor($link_color) + public function setLinkColor(?string $link_color) { if (is_null($link_color)) { - throw new \InvalidArgumentException('non-nullable link_color cannot be null'); + throw new InvalidArgumentException('non-nullable link_color cannot be null'); } $this->container['link_color'] = $link_color; @@ -540,10 +529,10 @@ public function getPageBackgroundColor() * * @return self */ - public function setPageBackgroundColor($page_background_color) + public function setPageBackgroundColor(?string $page_background_color) { if (is_null($page_background_color)) { - throw new \InvalidArgumentException('non-nullable page_background_color cannot be null'); + throw new InvalidArgumentException('non-nullable page_background_color cannot be null'); } $this->container['page_background_color'] = $page_background_color; @@ -567,10 +556,10 @@ public function getPrimaryButtonColor() * * @return self */ - public function setPrimaryButtonColor($primary_button_color) + public function setPrimaryButtonColor(?string $primary_button_color) { if (is_null($primary_button_color)) { - throw new \InvalidArgumentException('non-nullable primary_button_color cannot be null'); + throw new InvalidArgumentException('non-nullable primary_button_color cannot be null'); } $this->container['primary_button_color'] = $primary_button_color; @@ -594,10 +583,10 @@ public function getPrimaryButtonColorHover() * * @return self */ - public function setPrimaryButtonColorHover($primary_button_color_hover) + public function setPrimaryButtonColorHover(?string $primary_button_color_hover) { if (is_null($primary_button_color_hover)) { - throw new \InvalidArgumentException('non-nullable primary_button_color_hover cannot be null'); + throw new InvalidArgumentException('non-nullable primary_button_color_hover cannot be null'); } $this->container['primary_button_color_hover'] = $primary_button_color_hover; @@ -621,10 +610,10 @@ public function getPrimaryButtonTextColor() * * @return self */ - public function setPrimaryButtonTextColor($primary_button_text_color) + public function setPrimaryButtonTextColor(?string $primary_button_text_color) { if (is_null($primary_button_text_color)) { - throw new \InvalidArgumentException('non-nullable primary_button_text_color cannot be null'); + throw new InvalidArgumentException('non-nullable primary_button_text_color cannot be null'); } $this->container['primary_button_text_color'] = $primary_button_text_color; @@ -648,10 +637,10 @@ public function getPrimaryButtonTextColorHover() * * @return self */ - public function setPrimaryButtonTextColorHover($primary_button_text_color_hover) + public function setPrimaryButtonTextColorHover(?string $primary_button_text_color_hover) { if (is_null($primary_button_text_color_hover)) { - throw new \InvalidArgumentException('non-nullable primary_button_text_color_hover cannot be null'); + throw new InvalidArgumentException('non-nullable primary_button_text_color_hover cannot be null'); } $this->container['primary_button_text_color_hover'] = $primary_button_text_color_hover; @@ -675,10 +664,10 @@ public function getSecondaryButtonColor() * * @return self */ - public function setSecondaryButtonColor($secondary_button_color) + public function setSecondaryButtonColor(?string $secondary_button_color) { if (is_null($secondary_button_color)) { - throw new \InvalidArgumentException('non-nullable secondary_button_color cannot be null'); + throw new InvalidArgumentException('non-nullable secondary_button_color cannot be null'); } $this->container['secondary_button_color'] = $secondary_button_color; @@ -702,10 +691,10 @@ public function getSecondaryButtonColorHover() * * @return self */ - public function setSecondaryButtonColorHover($secondary_button_color_hover) + public function setSecondaryButtonColorHover(?string $secondary_button_color_hover) { if (is_null($secondary_button_color_hover)) { - throw new \InvalidArgumentException('non-nullable secondary_button_color_hover cannot be null'); + throw new InvalidArgumentException('non-nullable secondary_button_color_hover cannot be null'); } $this->container['secondary_button_color_hover'] = $secondary_button_color_hover; @@ -729,10 +718,10 @@ public function getSecondaryButtonTextColor() * * @return self */ - public function setSecondaryButtonTextColor($secondary_button_text_color) + public function setSecondaryButtonTextColor(?string $secondary_button_text_color) { if (is_null($secondary_button_text_color)) { - throw new \InvalidArgumentException('non-nullable secondary_button_text_color cannot be null'); + throw new InvalidArgumentException('non-nullable secondary_button_text_color cannot be null'); } $this->container['secondary_button_text_color'] = $secondary_button_text_color; @@ -756,10 +745,10 @@ public function getSecondaryButtonTextColorHover() * * @return self */ - public function setSecondaryButtonTextColorHover($secondary_button_text_color_hover) + public function setSecondaryButtonTextColorHover(?string $secondary_button_text_color_hover) { if (is_null($secondary_button_text_color_hover)) { - throw new \InvalidArgumentException('non-nullable secondary_button_text_color_hover cannot be null'); + throw new InvalidArgumentException('non-nullable secondary_button_text_color_hover cannot be null'); } $this->container['secondary_button_text_color_hover'] = $secondary_button_text_color_hover; @@ -783,10 +772,10 @@ public function getTextColor1() * * @return self */ - public function setTextColor1($text_color1) + public function setTextColor1(?string $text_color1) { if (is_null($text_color1)) { - throw new \InvalidArgumentException('non-nullable text_color1 cannot be null'); + throw new InvalidArgumentException('non-nullable text_color1 cannot be null'); } $this->container['text_color1'] = $text_color1; @@ -810,10 +799,10 @@ public function getTextColor2() * * @return self */ - public function setTextColor2($text_color2) + public function setTextColor2(?string $text_color2) { if (is_null($text_color2)) { - throw new \InvalidArgumentException('non-nullable text_color2 cannot be null'); + throw new InvalidArgumentException('non-nullable text_color2 cannot be null'); } $this->container['text_color2'] = $text_color2; @@ -837,23 +826,22 @@ public function getResetToDefault() * * @return self */ - public function setResetToDefault($reset_to_default) + public function setResetToDefault(?bool $reset_to_default) { if (is_null($reset_to_default)) { - throw new \InvalidArgumentException('non-nullable reset_to_default cannot be null'); + throw new InvalidArgumentException('non-nullable reset_to_default cannot be null'); } $this->container['reset_to_default'] = $reset_to_default; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -862,11 +850,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -877,10 +865,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -893,11 +879,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -905,15 +889,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -939,5 +923,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamAddMemberRequest.php b/sdks/php/src/Model/TeamAddMemberRequest.php index f3b1bbe91..e38abb02f 100644 --- a/sdks/php/src/Model/TeamAddMemberRequest.php +++ b/sdks/php/src/Model/TeamAddMemberRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamAddMemberRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamAddMemberRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamAddMemberRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamAddMemberRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', - 'role' => 'string' + 'role' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => 'email', - 'role' => null + 'role' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, - 'role' => false + 'role' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'account_id' => 'account_id', 'email_address' => 'email_address', - 'role' => 'role' + 'role' => 'role', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'account_id' => 'setAccountId', 'email_address' => 'setEmailAddress', - 'role' => 'setRole' + 'role' => 'setRole', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'account_id' => 'getAccountId', 'email_address' => 'getEmailAddress', - 'role' => 'getRole' + 'role' => 'getRole', ]; /** @@ -281,34 +272,33 @@ public function __construct(array $data = null) $this->setIfExists('role', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamAddMemberRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamAddMemberRequest { /** @var TeamAddMemberRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamAddMemberRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -350,7 +340,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account_id * @@ -368,10 +357,10 @@ public function getAccountId() * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -395,10 +384,10 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -422,14 +411,14 @@ public function getRole() * * @return self */ - public function setRole($role) + public function setRole(?string $role) { if (is_null($role)) { - throw new \InvalidArgumentException('non-nullable role cannot be null'); + throw new InvalidArgumentException('non-nullable role cannot be null'); } $allowedValues = $this->getRoleAllowableValues(); if (!in_array($role, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'role', must be one of '%s'", $role, @@ -441,14 +430,13 @@ public function setRole($role) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -457,11 +445,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -472,10 +460,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -488,11 +474,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -500,15 +484,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -534,5 +518,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamCreateRequest.php b/sdks/php/src/Model/TeamCreateRequest.php index 8dc152f06..6ba37cc71 100644 --- a/sdks/php/src/Model/TeamCreateRequest.php +++ b/sdks/php/src/Model/TeamCreateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamCreateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'name' => 'string' + 'name' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'name' => null + 'name' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'name' => false + 'name' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'name' => 'name' + 'name' => 'name', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'name' => 'setName' + 'name' => 'setName', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'name' => 'getName' + 'name' => 'getName', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], 'Untitled Team'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamCreateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamCreateRequest { /** @var TeamCreateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamCreateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -292,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -308,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -322,27 +308,26 @@ public function getName() /** * Sets name * - * @param string|null $name The name of your Team. + * @param string|null $name the name of your Team * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -351,11 +336,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -366,10 +351,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -382,11 +365,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -394,15 +375,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -428,5 +409,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamGetInfoResponse.php b/sdks/php/src/Model/TeamGetInfoResponse.php index a2f67e209..cfac0efbb 100644 --- a/sdks/php/src/Model/TeamGetInfoResponse.php +++ b/sdks/php/src/Model/TeamGetInfoResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamGetInfoResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamGetInfoResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamGetInfoResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamGetInfoResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team' => '\Dropbox\Sign\Model\TeamInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'team' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'team' => 'team', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'team' => 'setTeam', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'team' => 'getTeam', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamGetInfoResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamGetInfoResponse { /** @var TeamGetInfoResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamGetInfoResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets team * - * @return \Dropbox\Sign\Model\TeamInfoResponse + * @return TeamInfoResponse */ public function getTeam() { @@ -332,14 +320,14 @@ public function getTeam() /** * Sets team * - * @param \Dropbox\Sign\Model\TeamInfoResponse $team team + * @param TeamInfoResponse $team team * * @return self */ - public function setTeam($team) + public function setTeam(TeamInfoResponse $team) { if (is_null($team)) { - throw new \InvalidArgumentException('non-nullable team cannot be null'); + throw new InvalidArgumentException('non-nullable team cannot be null'); } $this->container['team'] = $team; @@ -349,7 +337,7 @@ public function setTeam($team) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamGetResponse.php b/sdks/php/src/Model/TeamGetResponse.php index bc857c1d2..6d23ddc3b 100644 --- a/sdks/php/src/Model/TeamGetResponse.php +++ b/sdks/php/src/Model/TeamGetResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamGetResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamGetResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team' => '\Dropbox\Sign\Model\TeamResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'team' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'team' => 'team', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'team' => 'setTeam', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'team' => 'getTeam', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamGetResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamGetResponse { /** @var TeamGetResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamGetResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets team * - * @return \Dropbox\Sign\Model\TeamResponse + * @return TeamResponse */ public function getTeam() { @@ -332,14 +320,14 @@ public function getTeam() /** * Sets team * - * @param \Dropbox\Sign\Model\TeamResponse $team team + * @param TeamResponse $team team * * @return self */ - public function setTeam($team) + public function setTeam(TeamResponse $team) { if (is_null($team)) { - throw new \InvalidArgumentException('non-nullable team cannot be null'); + throw new InvalidArgumentException('non-nullable team cannot be null'); } $this->container['team'] = $team; @@ -349,7 +337,7 @@ public function setTeam($team) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamInfoResponse.php b/sdks/php/src/Model/TeamInfoResponse.php index 883e1467e..3d5ad124a 100644 --- a/sdks/php/src/Model/TeamInfoResponse.php +++ b/sdks/php/src/Model/TeamInfoResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,75 +27,76 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamInfoResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamInfoResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamInfoResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamInfoResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team_id' => 'string', 'team_parent' => '\Dropbox\Sign\Model\TeamParentResponse', 'name' => 'string', 'num_members' => 'int', - 'num_sub_teams' => 'int' + 'num_sub_teams' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team_id' => null, 'team_parent' => null, 'name' => null, 'num_members' => null, - 'num_sub_teams' => null + 'num_sub_teams' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'team_id' => false, 'team_parent' => true, 'name' => false, 'num_members' => false, - 'num_sub_teams' => false + 'num_sub_teams' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -122,8 +121,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -133,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -143,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -152,9 +149,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -163,9 +157,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -183,7 +174,7 @@ public function isNullableSetToNull(string $property): bool 'team_parent' => 'team_parent', 'name' => 'name', 'num_members' => 'num_members', - 'num_sub_teams' => 'num_sub_teams' + 'num_sub_teams' => 'num_sub_teams', ]; /** @@ -196,7 +187,7 @@ public function isNullableSetToNull(string $property): bool 'team_parent' => 'setTeamParent', 'name' => 'setName', 'num_members' => 'setNumMembers', - 'num_sub_teams' => 'setNumSubTeams' + 'num_sub_teams' => 'setNumSubTeams', ]; /** @@ -209,7 +200,7 @@ public function isNullableSetToNull(string $property): bool 'team_parent' => 'getTeamParent', 'name' => 'getName', 'num_members' => 'getNumMembers', - 'num_sub_teams' => 'getNumSubTeams' + 'num_sub_teams' => 'getNumSubTeams', ]; /** @@ -253,7 +244,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -276,34 +266,33 @@ public function __construct(array $data = null) $this->setIfExists('num_sub_teams', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamInfoResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamInfoResponse { /** @var TeamInfoResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamInfoResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -320,9 +309,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -336,7 +323,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets team_id * @@ -354,10 +340,10 @@ public function getTeamId() * * @return self */ - public function setTeamId($team_id) + public function setTeamId(?string $team_id) { if (is_null($team_id)) { - throw new \InvalidArgumentException('non-nullable team_id cannot be null'); + throw new InvalidArgumentException('non-nullable team_id cannot be null'); } $this->container['team_id'] = $team_id; @@ -367,7 +353,7 @@ public function setTeamId($team_id) /** * Gets team_parent * - * @return \Dropbox\Sign\Model\TeamParentResponse|null + * @return TeamParentResponse|null */ public function getTeamParent() { @@ -377,18 +363,18 @@ public function getTeamParent() /** * Sets team_parent * - * @param \Dropbox\Sign\Model\TeamParentResponse|null $team_parent team_parent + * @param TeamParentResponse|null $team_parent team_parent * * @return self */ - public function setTeamParent($team_parent) + public function setTeamParent(?TeamParentResponse $team_parent) { if (is_null($team_parent)) { array_push($this->openAPINullablesSetToNull, 'team_parent'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('team_parent', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -415,10 +401,10 @@ public function getName() * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -442,10 +428,10 @@ public function getNumMembers() * * @return self */ - public function setNumMembers($num_members) + public function setNumMembers(?int $num_members) { if (is_null($num_members)) { - throw new \InvalidArgumentException('non-nullable num_members cannot be null'); + throw new InvalidArgumentException('non-nullable num_members cannot be null'); } $this->container['num_members'] = $num_members; @@ -469,23 +455,22 @@ public function getNumSubTeams() * * @return self */ - public function setNumSubTeams($num_sub_teams) + public function setNumSubTeams(?int $num_sub_teams) { if (is_null($num_sub_teams)) { - throw new \InvalidArgumentException('non-nullable num_sub_teams cannot be null'); + throw new InvalidArgumentException('non-nullable num_sub_teams cannot be null'); } $this->container['num_sub_teams'] = $num_sub_teams; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -494,11 +479,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -509,10 +494,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -525,11 +508,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -537,15 +518,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -571,5 +552,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamInviteResponse.php b/sdks/php/src/Model/TeamInviteResponse.php index 09f76a85b..d37dae050 100644 --- a/sdks/php/src/Model/TeamInviteResponse.php +++ b/sdks/php/src/Model/TeamInviteResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,78 +27,79 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamInviteResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamInviteResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamInviteResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamInviteResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'email_address' => 'string', 'team_id' => 'string', 'role' => 'string', 'sent_at' => 'int', 'redeemed_at' => 'int', - 'expires_at' => 'int' + 'expires_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'email_address' => null, 'team_id' => null, 'role' => null, 'sent_at' => null, 'redeemed_at' => null, - 'expires_at' => null + 'expires_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'email_address' => false, 'team_id' => false, 'role' => false, 'sent_at' => false, 'redeemed_at' => false, - 'expires_at' => false + 'expires_at' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -125,8 +124,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -136,7 +133,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -146,7 +143,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -155,9 +152,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -166,9 +160,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -187,7 +178,7 @@ public function isNullableSetToNull(string $property): bool 'role' => 'role', 'sent_at' => 'sent_at', 'redeemed_at' => 'redeemed_at', - 'expires_at' => 'expires_at' + 'expires_at' => 'expires_at', ]; /** @@ -201,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'role' => 'setRole', 'sent_at' => 'setSentAt', 'redeemed_at' => 'setRedeemedAt', - 'expires_at' => 'setExpiresAt' + 'expires_at' => 'setExpiresAt', ]; /** @@ -215,7 +206,7 @@ public function isNullableSetToNull(string $property): bool 'role' => 'getRole', 'sent_at' => 'getSentAt', 'redeemed_at' => 'getRedeemedAt', - 'expires_at' => 'getExpiresAt' + 'expires_at' => 'getExpiresAt', ]; /** @@ -259,7 +250,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -283,34 +273,33 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamInviteResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamInviteResponse { /** @var TeamInviteResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamInviteResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -327,9 +316,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -343,7 +330,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets email_address * @@ -357,14 +343,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address Email address of the user invited to this team. + * @param string|null $email_address email address of the user invited to this team * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -384,14 +370,14 @@ public function getTeamId() /** * Sets team_id * - * @param string|null $team_id Id of the team. + * @param string|null $team_id id of the team * * @return self */ - public function setTeamId($team_id) + public function setTeamId(?string $team_id) { if (is_null($team_id)) { - throw new \InvalidArgumentException('non-nullable team_id cannot be null'); + throw new InvalidArgumentException('non-nullable team_id cannot be null'); } $this->container['team_id'] = $team_id; @@ -411,14 +397,14 @@ public function getRole() /** * Sets role * - * @param string|null $role Role of the user invited to this team. + * @param string|null $role role of the user invited to this team * * @return self */ - public function setRole($role) + public function setRole(?string $role) { if (is_null($role)) { - throw new \InvalidArgumentException('non-nullable role cannot be null'); + throw new InvalidArgumentException('non-nullable role cannot be null'); } $this->container['role'] = $role; @@ -438,14 +424,14 @@ public function getSentAt() /** * Sets sent_at * - * @param int|null $sent_at Timestamp when the invitation was sent. + * @param int|null $sent_at timestamp when the invitation was sent * * @return self */ - public function setSentAt($sent_at) + public function setSentAt(?int $sent_at) { if (is_null($sent_at)) { - throw new \InvalidArgumentException('non-nullable sent_at cannot be null'); + throw new InvalidArgumentException('non-nullable sent_at cannot be null'); } $this->container['sent_at'] = $sent_at; @@ -465,14 +451,14 @@ public function getRedeemedAt() /** * Sets redeemed_at * - * @param int|null $redeemed_at Timestamp when the invitation was redeemed. + * @param int|null $redeemed_at timestamp when the invitation was redeemed * * @return self */ - public function setRedeemedAt($redeemed_at) + public function setRedeemedAt(?int $redeemed_at) { if (is_null($redeemed_at)) { - throw new \InvalidArgumentException('non-nullable redeemed_at cannot be null'); + throw new InvalidArgumentException('non-nullable redeemed_at cannot be null'); } $this->container['redeemed_at'] = $redeemed_at; @@ -492,27 +478,26 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at Timestamp when the invitation is expiring. + * @param int|null $expires_at timestamp when the invitation is expiring * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { - throw new \InvalidArgumentException('non-nullable expires_at cannot be null'); + throw new InvalidArgumentException('non-nullable expires_at cannot be null'); } $this->container['expires_at'] = $expires_at; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -521,11 +506,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -536,10 +521,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -552,11 +535,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -564,15 +545,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -598,5 +579,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamInvitesResponse.php b/sdks/php/src/Model/TeamInvitesResponse.php index 6734607b0..31b58b939 100644 --- a/sdks/php/src/Model/TeamInvitesResponse.php +++ b/sdks/php/src/Model/TeamInvitesResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamInvitesResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamInvitesResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamInvitesResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamInvitesResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team_invites' => '\Dropbox\Sign\Model\TeamInviteResponse[]', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team_invites' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'team_invites' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'team_invites' => 'team_invites', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'team_invites' => 'setTeamInvites', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'team_invites' => 'getTeamInvites', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamInvitesResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamInvitesResponse { /** @var TeamInvitesResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamInvitesResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets team_invites * - * @return \Dropbox\Sign\Model\TeamInviteResponse[] + * @return TeamInviteResponse[] */ public function getTeamInvites() { @@ -332,14 +320,14 @@ public function getTeamInvites() /** * Sets team_invites * - * @param \Dropbox\Sign\Model\TeamInviteResponse[] $team_invites Contains a list of team invites and their roles. + * @param TeamInviteResponse[] $team_invites contains a list of team invites and their roles * * @return self */ - public function setTeamInvites($team_invites) + public function setTeamInvites(array $team_invites) { if (is_null($team_invites)) { - throw new \InvalidArgumentException('non-nullable team_invites cannot be null'); + throw new InvalidArgumentException('non-nullable team_invites cannot be null'); } $this->container['team_invites'] = $team_invites; @@ -349,7 +337,7 @@ public function setTeamInvites($team_invites) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings warnings + * @param WarningResponse[]|null $warnings warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamMemberResponse.php b/sdks/php/src/Model/TeamMemberResponse.php index 149b4db2b..ee61fbdd3 100644 --- a/sdks/php/src/Model/TeamMemberResponse.php +++ b/sdks/php/src/Model/TeamMemberResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamMemberResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamMemberResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamMemberResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamMemberResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', - 'role' => 'string' + 'role' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => null, - 'role' => null + 'role' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, - 'role' => false + 'role' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'account_id' => 'account_id', 'email_address' => 'email_address', - 'role' => 'role' + 'role' => 'role', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'account_id' => 'setAccountId', 'email_address' => 'setEmailAddress', - 'role' => 'setRole' + 'role' => 'setRole', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'account_id' => 'getAccountId', 'email_address' => 'getEmailAddress', - 'role' => 'getRole' + 'role' => 'getRole', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('role', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamMemberResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamMemberResponse { /** @var TeamMemberResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamMemberResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,9 +295,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -322,7 +309,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account_id * @@ -336,14 +322,14 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id Account id of the team member. + * @param string|null $account_id account id of the team member * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -363,14 +349,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address Email address of the team member. + * @param string|null $email_address email address of the team member * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -390,27 +376,26 @@ public function getRole() /** * Sets role * - * @param string|null $role The specific role a member has on the team. + * @param string|null $role the specific role a member has on the team * * @return self */ - public function setRole($role) + public function setRole(?string $role) { if (is_null($role)) { - throw new \InvalidArgumentException('non-nullable role cannot be null'); + throw new InvalidArgumentException('non-nullable role cannot be null'); } $this->container['role'] = $role; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -419,11 +404,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -434,10 +419,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -450,11 +433,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -462,15 +443,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -496,5 +477,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamMembersResponse.php b/sdks/php/src/Model/TeamMembersResponse.php index b71d18b88..681ad9af1 100644 --- a/sdks/php/src/Model/TeamMembersResponse.php +++ b/sdks/php/src/Model/TeamMembersResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamMembersResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamMembersResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamMembersResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamMembersResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team_members' => '\Dropbox\Sign\Model\TeamMemberResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team_members' => null, 'list_info' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'team_members' => false, 'list_info' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'team_members' => 'team_members', 'list_info' => 'list_info', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'team_members' => 'setTeamMembers', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'team_members' => 'getTeamMembers', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamMembersResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamMembersResponse { /** @var TeamMembersResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamMembersResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,11 +317,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets team_members * - * @return \Dropbox\Sign\Model\TeamMemberResponse[] + * @return TeamMemberResponse[] */ public function getTeamMembers() { @@ -342,14 +330,14 @@ public function getTeamMembers() /** * Sets team_members * - * @param \Dropbox\Sign\Model\TeamMemberResponse[] $team_members Contains a list of team members and their roles for a specific team. + * @param TeamMemberResponse[] $team_members contains a list of team members and their roles for a specific team * * @return self */ - public function setTeamMembers($team_members) + public function setTeamMembers(array $team_members) { if (is_null($team_members)) { - throw new \InvalidArgumentException('non-nullable team_members cannot be null'); + throw new InvalidArgumentException('non-nullable team_members cannot be null'); } $this->container['team_members'] = $team_members; @@ -359,7 +347,7 @@ public function setTeamMembers($team_members) /** * Gets list_info * - * @return \Dropbox\Sign\Model\ListInfoResponse + * @return ListInfoResponse */ public function getListInfo() { @@ -369,14 +357,14 @@ public function getListInfo() /** * Sets list_info * - * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info + * @param ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo($list_info) + public function setListInfo(ListInfoResponse $list_info) { if (is_null($list_info)) { - throw new \InvalidArgumentException('non-nullable list_info cannot be null'); + throw new InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -386,7 +374,7 @@ public function setListInfo($list_info) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -396,27 +384,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings warnings + * @param WarningResponse[]|null $warnings warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -425,11 +412,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -440,10 +427,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -456,11 +441,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -468,15 +451,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -502,5 +485,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamParentResponse.php b/sdks/php/src/Model/TeamParentResponse.php index 7c4d355cd..d0d447285 100644 --- a/sdks/php/src/Model/TeamParentResponse.php +++ b/sdks/php/src/Model/TeamParentResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,67 +27,68 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamParentResponse Class Doc Comment * * @category Class * @description Information about the parent team if a team has one, set to `null` otherwise. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamParentResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamParentResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamParentResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'team_id' => 'string', - 'name' => 'string' + 'name' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'team_id' => null, - 'name' => null + 'name' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'team_id' => false, - 'name' => false + 'name' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -172,7 +163,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'team_id' => 'team_id', - 'name' => 'name' + 'name' => 'name', ]; /** @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'team_id' => 'setTeamId', - 'name' => 'setName' + 'name' => 'setName', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'team_id' => 'getTeamId', - 'name' => 'getName' + 'name' => 'getName', ]; /** @@ -236,7 +227,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -256,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamParentResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamParentResponse { /** @var TeamParentResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamParentResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,9 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -316,7 +303,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets team_id * @@ -334,10 +320,10 @@ public function getTeamId() * * @return self */ - public function setTeamId($team_id) + public function setTeamId(?string $team_id) { if (is_null($team_id)) { - throw new \InvalidArgumentException('non-nullable team_id cannot be null'); + throw new InvalidArgumentException('non-nullable team_id cannot be null'); } $this->container['team_id'] = $team_id; @@ -361,23 +347,22 @@ public function getName() * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -386,11 +371,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -401,10 +386,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -417,11 +400,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -429,15 +410,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -463,5 +444,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamRemoveMemberRequest.php b/sdks/php/src/Model/TeamRemoveMemberRequest.php index 9c066146e..6d7413255 100644 --- a/sdks/php/src/Model/TeamRemoveMemberRequest.php +++ b/sdks/php/src/Model/TeamRemoveMemberRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,75 +27,76 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamRemoveMemberRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamRemoveMemberRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamRemoveMemberRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamRemoveMemberRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', 'new_owner_email_address' => 'string', 'new_team_id' => 'string', - 'new_role' => 'string' + 'new_role' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => 'email', 'new_owner_email_address' => 'email', 'new_team_id' => null, - 'new_role' => null + 'new_role' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, 'new_owner_email_address' => false, 'new_team_id' => false, - 'new_role' => false + 'new_role' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -122,8 +121,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -133,7 +130,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -143,7 +140,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -152,9 +149,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -163,9 +157,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -183,7 +174,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'email_address', 'new_owner_email_address' => 'new_owner_email_address', 'new_team_id' => 'new_team_id', - 'new_role' => 'new_role' + 'new_role' => 'new_role', ]; /** @@ -196,7 +187,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'setEmailAddress', 'new_owner_email_address' => 'setNewOwnerEmailAddress', 'new_team_id' => 'setNewTeamId', - 'new_role' => 'setNewRole' + 'new_role' => 'setNewRole', ]; /** @@ -209,7 +200,7 @@ public function isNullableSetToNull(string $property): bool 'email_address' => 'getEmailAddress', 'new_owner_email_address' => 'getNewOwnerEmailAddress', 'new_team_id' => 'getNewTeamId', - 'new_role' => 'getNewRole' + 'new_role' => 'getNewRole', ]; /** @@ -295,34 +286,33 @@ public function __construct(array $data = null) $this->setIfExists('new_role', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamRemoveMemberRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamRemoveMemberRequest { /** @var TeamRemoveMemberRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamRemoveMemberRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -364,7 +354,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account_id * @@ -382,10 +371,10 @@ public function getAccountId() * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -409,10 +398,10 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -436,10 +425,10 @@ public function getNewOwnerEmailAddress() * * @return self */ - public function setNewOwnerEmailAddress($new_owner_email_address) + public function setNewOwnerEmailAddress(?string $new_owner_email_address) { if (is_null($new_owner_email_address)) { - throw new \InvalidArgumentException('non-nullable new_owner_email_address cannot be null'); + throw new InvalidArgumentException('non-nullable new_owner_email_address cannot be null'); } $this->container['new_owner_email_address'] = $new_owner_email_address; @@ -459,14 +448,14 @@ public function getNewTeamId() /** * Sets new_team_id * - * @param string|null $new_team_id Id of the new Team. + * @param string|null $new_team_id id of the new Team * * @return self */ - public function setNewTeamId($new_team_id) + public function setNewTeamId(?string $new_team_id) { if (is_null($new_team_id)) { - throw new \InvalidArgumentException('non-nullable new_team_id cannot be null'); + throw new InvalidArgumentException('non-nullable new_team_id cannot be null'); } $this->container['new_team_id'] = $new_team_id; @@ -490,14 +479,14 @@ public function getNewRole() * * @return self */ - public function setNewRole($new_role) + public function setNewRole(?string $new_role) { if (is_null($new_role)) { - throw new \InvalidArgumentException('non-nullable new_role cannot be null'); + throw new InvalidArgumentException('non-nullable new_role cannot be null'); } $allowedValues = $this->getNewRoleAllowableValues(); if (!in_array($new_role, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'new_role', must be one of '%s'", $new_role, @@ -509,14 +498,13 @@ public function setNewRole($new_role) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -525,11 +513,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -540,10 +528,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -556,11 +542,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -568,15 +552,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -602,5 +586,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamResponse.php b/sdks/php/src/Model/TeamResponse.php index 8c22319a0..402916a49 100644 --- a/sdks/php/src/Model/TeamResponse.php +++ b/sdks/php/src/Model/TeamResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,73 +27,74 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamResponse Class Doc Comment * * @category Class * @description Contains information about your team and its members - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', 'accounts' => '\Dropbox\Sign\Model\AccountResponse[]', 'invited_accounts' => '\Dropbox\Sign\Model\AccountResponse[]', - 'invited_emails' => 'string[]' + 'invited_emails' => 'string[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, 'accounts' => null, 'invited_accounts' => null, - 'invited_emails' => null + 'invited_emails' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'name' => false, 'accounts' => false, 'invited_accounts' => false, - 'invited_emails' => false + 'invited_emails' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,8 +119,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -131,7 +128,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +138,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,9 +147,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -161,9 +155,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'name', 'accounts' => 'accounts', 'invited_accounts' => 'invited_accounts', - 'invited_emails' => 'invited_emails' + 'invited_emails' => 'invited_emails', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'setName', 'accounts' => 'setAccounts', 'invited_accounts' => 'setInvitedAccounts', - 'invited_emails' => 'setInvitedEmails' + 'invited_emails' => 'setInvitedEmails', ]; /** @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'name' => 'getName', 'accounts' => 'getAccounts', 'invited_accounts' => 'getInvitedAccounts', - 'invited_emails' => 'getInvitedEmails' + 'invited_emails' => 'getInvitedEmails', ]; /** @@ -248,7 +239,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -270,34 +260,33 @@ public function __construct(array $data = null) $this->setIfExists('invited_emails', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamResponse { /** @var TeamResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,9 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -330,7 +317,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -348,10 +334,10 @@ public function getName() * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -361,7 +347,7 @@ public function setName($name) /** * Gets accounts * - * @return \Dropbox\Sign\Model\AccountResponse[]|null + * @return AccountResponse[]|null */ public function getAccounts() { @@ -371,14 +357,14 @@ public function getAccounts() /** * Sets accounts * - * @param \Dropbox\Sign\Model\AccountResponse[]|null $accounts accounts + * @param AccountResponse[]|null $accounts accounts * * @return self */ - public function setAccounts($accounts) + public function setAccounts(?array $accounts) { if (is_null($accounts)) { - throw new \InvalidArgumentException('non-nullable accounts cannot be null'); + throw new InvalidArgumentException('non-nullable accounts cannot be null'); } $this->container['accounts'] = $accounts; @@ -388,7 +374,7 @@ public function setAccounts($accounts) /** * Gets invited_accounts * - * @return \Dropbox\Sign\Model\AccountResponse[]|null + * @return AccountResponse[]|null */ public function getInvitedAccounts() { @@ -398,14 +384,14 @@ public function getInvitedAccounts() /** * Sets invited_accounts * - * @param \Dropbox\Sign\Model\AccountResponse[]|null $invited_accounts A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. + * @param AccountResponse[]|null $invited_accounts A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. * * @return self */ - public function setInvitedAccounts($invited_accounts) + public function setInvitedAccounts(?array $invited_accounts) { if (is_null($invited_accounts)) { - throw new \InvalidArgumentException('non-nullable invited_accounts cannot be null'); + throw new InvalidArgumentException('non-nullable invited_accounts cannot be null'); } $this->container['invited_accounts'] = $invited_accounts; @@ -425,27 +411,26 @@ public function getInvitedEmails() /** * Sets invited_emails * - * @param string[]|null $invited_emails A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. + * @param string[]|null $invited_emails a list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account * * @return self */ - public function setInvitedEmails($invited_emails) + public function setInvitedEmails(?array $invited_emails) { if (is_null($invited_emails)) { - throw new \InvalidArgumentException('non-nullable invited_emails cannot be null'); + throw new InvalidArgumentException('non-nullable invited_emails cannot be null'); } $this->container['invited_emails'] = $invited_emails; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -454,11 +439,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -469,10 +454,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -485,11 +468,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -497,15 +478,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -531,5 +512,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamSubTeamsResponse.php b/sdks/php/src/Model/TeamSubTeamsResponse.php index f4a3bc91a..e3e9206c2 100644 --- a/sdks/php/src/Model/TeamSubTeamsResponse.php +++ b/sdks/php/src/Model/TeamSubTeamsResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamSubTeamsResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamSubTeamsResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamSubTeamsResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamSubTeamsResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'sub_teams' => '\Dropbox\Sign\Model\SubTeamResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'sub_teams' => null, 'list_info' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'sub_teams' => false, 'list_info' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'sub_teams' => 'sub_teams', 'list_info' => 'list_info', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'sub_teams' => 'setSubTeams', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'sub_teams' => 'getSubTeams', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamSubTeamsResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamSubTeamsResponse { /** @var TeamSubTeamsResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamSubTeamsResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,11 +317,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets sub_teams * - * @return \Dropbox\Sign\Model\SubTeamResponse[] + * @return SubTeamResponse[] */ public function getSubTeams() { @@ -342,14 +330,14 @@ public function getSubTeams() /** * Sets sub_teams * - * @param \Dropbox\Sign\Model\SubTeamResponse[] $sub_teams Contains a list with sub teams. + * @param SubTeamResponse[] $sub_teams contains a list with sub teams * * @return self */ - public function setSubTeams($sub_teams) + public function setSubTeams(array $sub_teams) { if (is_null($sub_teams)) { - throw new \InvalidArgumentException('non-nullable sub_teams cannot be null'); + throw new InvalidArgumentException('non-nullable sub_teams cannot be null'); } $this->container['sub_teams'] = $sub_teams; @@ -359,7 +347,7 @@ public function setSubTeams($sub_teams) /** * Gets list_info * - * @return \Dropbox\Sign\Model\ListInfoResponse + * @return ListInfoResponse */ public function getListInfo() { @@ -369,14 +357,14 @@ public function getListInfo() /** * Sets list_info * - * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info + * @param ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo($list_info) + public function setListInfo(ListInfoResponse $list_info) { if (is_null($list_info)) { - throw new \InvalidArgumentException('non-nullable list_info cannot be null'); + throw new InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -386,7 +374,7 @@ public function setListInfo($list_info) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -396,27 +384,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings warnings + * @param WarningResponse[]|null $warnings warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -425,11 +412,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -440,10 +427,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -456,11 +441,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -468,15 +451,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -502,5 +485,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TeamUpdateRequest.php b/sdks/php/src/Model/TeamUpdateRequest.php index ad86dbe8f..6606b7676 100644 --- a/sdks/php/src/Model/TeamUpdateRequest.php +++ b/sdks/php/src/Model/TeamUpdateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TeamUpdateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TeamUpdateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class TeamUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TeamUpdateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'name' => 'string' + 'name' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'name' => null + 'name' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'name' => false + 'name' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'name' => 'name' + 'name' => 'name', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'name' => 'setName' + 'name' => 'setName', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'name' => 'getName' + 'name' => 'getName', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TeamUpdateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TeamUpdateRequest { /** @var TeamUpdateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TeamUpdateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -292,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -308,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -322,27 +308,26 @@ public function getName() /** * Sets name * - * @param string|null $name The name of your Team. + * @param string|null $name the name of your Team * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -351,11 +336,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -366,10 +351,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -382,11 +365,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -394,15 +375,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -428,5 +409,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateAddUserRequest.php b/sdks/php/src/Model/TemplateAddUserRequest.php index f109a3747..ea87103ad 100644 --- a/sdks/php/src/Model/TemplateAddUserRequest.php +++ b/sdks/php/src/Model/TemplateAddUserRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateAddUserRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateAddUserRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateAddUserRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateAddUserRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', - 'skip_notification' => 'bool' + 'skip_notification' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => 'email', - 'skip_notification' => null + 'skip_notification' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, - 'skip_notification' => false + 'skip_notification' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'account_id' => 'account_id', 'email_address' => 'email_address', - 'skip_notification' => 'skip_notification' + 'skip_notification' => 'skip_notification', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'account_id' => 'setAccountId', 'email_address' => 'setEmailAddress', - 'skip_notification' => 'setSkipNotification' + 'skip_notification' => 'setSkipNotification', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'account_id' => 'getAccountId', 'email_address' => 'getEmailAddress', - 'skip_notification' => 'getSkipNotification' + 'skip_notification' => 'getSkipNotification', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('skip_notification', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateAddUserRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateAddUserRequest { /** @var TemplateAddUserRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateAddUserRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,9 +295,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -322,7 +309,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account_id * @@ -340,10 +326,10 @@ public function getAccountId() * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -367,10 +353,10 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -394,23 +380,22 @@ public function getSkipNotification() * * @return self */ - public function setSkipNotification($skip_notification) + public function setSkipNotification(?bool $skip_notification) { if (is_null($skip_notification)) { - throw new \InvalidArgumentException('non-nullable skip_notification cannot be null'); + throw new InvalidArgumentException('non-nullable skip_notification cannot be null'); } $this->container['skip_notification'] = $skip_notification; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -419,11 +404,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -434,10 +419,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -450,11 +433,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -462,15 +443,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -496,5 +477,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php index 580875bc3..fe626a83a 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * TemplateCreateEmbeddedDraftRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateEmbeddedDraftRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'files' => '\SplFileObject[]', @@ -82,16 +82,16 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'subject' => 'string', 'test_mode' => 'bool', 'title' => 'string', - 'use_preexisting_fields' => 'bool' + 'use_preexisting_fields' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'files' => 'binary', @@ -117,14 +117,14 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'subject' => null, 'test_mode' => null, 'title' => null, - 'use_preexisting_fields' => null + 'use_preexisting_fields' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'files' => false, @@ -150,14 +150,14 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'subject' => false, 'test_mode' => false, 'title' => false, - 'use_preexisting_fields' => false + 'use_preexisting_fields' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -182,8 +182,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -193,7 +191,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -203,7 +201,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -212,9 +210,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -223,9 +218,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -263,7 +255,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'subject', 'test_mode' => 'test_mode', 'title' => 'title', - 'use_preexisting_fields' => 'use_preexisting_fields' + 'use_preexisting_fields' => 'use_preexisting_fields', ]; /** @@ -296,7 +288,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'setSubject', 'test_mode' => 'setTestMode', 'title' => 'setTitle', - 'use_preexisting_fields' => 'setUsePreexistingFields' + 'use_preexisting_fields' => 'setUsePreexistingFields', ]; /** @@ -329,7 +321,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'getSubject', 'test_mode' => 'getTestMode', 'title' => 'getTitle', - 'use_preexisting_fields' => 'getUsePreexistingFields' + 'use_preexisting_fields' => 'getUsePreexistingFields', ]; /** @@ -373,7 +365,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -416,34 +407,33 @@ public function __construct(array $data = null) $this->setIfExists('use_preexisting_fields', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateCreateEmbeddedDraftRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateCreateEmbeddedDraftRequest { /** @var TemplateCreateEmbeddedDraftRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateCreateEmbeddedDraftRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -487,7 +477,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets client_id * @@ -505,10 +494,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -518,7 +507,7 @@ public function setClientId($client_id) /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -528,14 +517,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -559,10 +548,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -582,14 +571,14 @@ public function getAllowCcs() /** * Sets allow_ccs * - * @param bool|null $allow_ccs This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. + * @param bool|null $allow_ccs this allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template * * @return self */ - public function setAllowCcs($allow_ccs) + public function setAllowCcs(?bool $allow_ccs) { if (is_null($allow_ccs)) { - throw new \InvalidArgumentException('non-nullable allow_ccs cannot be null'); + throw new InvalidArgumentException('non-nullable allow_ccs cannot be null'); } $this->container['allow_ccs'] = $allow_ccs; @@ -613,10 +602,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign($allow_reassign) + public function setAllowReassign(?bool $allow_reassign) { if (is_null($allow_reassign)) { - throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -626,7 +615,7 @@ public function setAllowReassign($allow_reassign) /** * Gets attachments * - * @return \Dropbox\Sign\Model\SubAttachment[]|null + * @return SubAttachment[]|null */ public function getAttachments() { @@ -636,14 +625,14 @@ public function getAttachments() /** * Sets attachments * - * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments($attachments) + public function setAttachments(?array $attachments) { if (is_null($attachments)) { - throw new \InvalidArgumentException('non-nullable attachments cannot be null'); + throw new InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -667,10 +656,10 @@ public function getCcRoles() * * @return self */ - public function setCcRoles($cc_roles) + public function setCcRoles(?array $cc_roles) { if (is_null($cc_roles)) { - throw new \InvalidArgumentException('non-nullable cc_roles cannot be null'); + throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); } $this->container['cc_roles'] = $cc_roles; @@ -680,7 +669,7 @@ public function setCcRoles($cc_roles) /** * Gets editor_options * - * @return \Dropbox\Sign\Model\SubEditorOptions|null + * @return SubEditorOptions|null */ public function getEditorOptions() { @@ -690,14 +679,14 @@ public function getEditorOptions() /** * Sets editor_options * - * @param \Dropbox\Sign\Model\SubEditorOptions|null $editor_options editor_options + * @param SubEditorOptions|null $editor_options editor_options * * @return self */ - public function setEditorOptions($editor_options) + public function setEditorOptions(?SubEditorOptions $editor_options) { if (is_null($editor_options)) { - throw new \InvalidArgumentException('non-nullable editor_options cannot be null'); + throw new InvalidArgumentException('non-nullable editor_options cannot be null'); } $this->container['editor_options'] = $editor_options; @@ -707,7 +696,7 @@ public function setEditorOptions($editor_options) /** * Gets field_options * - * @return \Dropbox\Sign\Model\SubFieldOptions|null + * @return SubFieldOptions|null */ public function getFieldOptions() { @@ -717,14 +706,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options + * @param SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions($field_options) + public function setFieldOptions(?SubFieldOptions $field_options) { if (is_null($field_options)) { - throw new \InvalidArgumentException('non-nullable field_options cannot be null'); + throw new InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -744,14 +733,14 @@ public function getForceSignerRoles() /** * Sets force_signer_roles * - * @param bool|null $force_signer_roles Provide users the ability to review/edit the template signer roles. + * @param bool|null $force_signer_roles provide users the ability to review/edit the template signer roles * * @return self */ - public function setForceSignerRoles($force_signer_roles) + public function setForceSignerRoles(?bool $force_signer_roles) { if (is_null($force_signer_roles)) { - throw new \InvalidArgumentException('non-nullable force_signer_roles cannot be null'); + throw new InvalidArgumentException('non-nullable force_signer_roles cannot be null'); } $this->container['force_signer_roles'] = $force_signer_roles; @@ -771,14 +760,14 @@ public function getForceSubjectMessage() /** * Sets force_subject_message * - * @param bool|null $force_subject_message Provide users the ability to review/edit the template subject and message. + * @param bool|null $force_subject_message provide users the ability to review/edit the template subject and message * * @return self */ - public function setForceSubjectMessage($force_subject_message) + public function setForceSubjectMessage(?bool $force_subject_message) { if (is_null($force_subject_message)) { - throw new \InvalidArgumentException('non-nullable force_subject_message cannot be null'); + throw new InvalidArgumentException('non-nullable force_subject_message cannot be null'); } $this->container['force_subject_message'] = $force_subject_message; @@ -788,7 +777,7 @@ public function setForceSubjectMessage($force_subject_message) /** * Gets form_field_groups * - * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null + * @return SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -798,14 +787,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups($form_field_groups) + public function setFormFieldGroups(?array $form_field_groups) { if (is_null($form_field_groups)) { - throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -815,7 +804,7 @@ public function setFormFieldGroups($form_field_groups) /** * Gets form_field_rules * - * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null + * @return SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -825,14 +814,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. + * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` * * @return self */ - public function setFormFieldRules($form_field_rules) + public function setFormFieldRules(?array $form_field_rules) { if (is_null($form_field_rules)) { - throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -842,7 +831,7 @@ public function setFormFieldRules($form_field_rules) /** * Gets form_fields_per_document * - * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null + * @return SubFormFieldsPerDocumentBase[]|null */ public function getFormFieldsPerDocument() { @@ -852,14 +841,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument($form_fields_per_document) + public function setFormFieldsPerDocument(?array $form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -869,7 +858,7 @@ public function setFormFieldsPerDocument($form_fields_per_document) /** * Gets merge_fields * - * @return \Dropbox\Sign\Model\SubMergeField[]|null + * @return SubMergeField[]|null */ public function getMergeFields() { @@ -879,14 +868,14 @@ public function getMergeFields() /** * Sets merge_fields * - * @param \Dropbox\Sign\Model\SubMergeField[]|null $merge_fields Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. + * @param SubMergeField[]|null $merge_fields Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. * * @return self */ - public function setMergeFields($merge_fields) + public function setMergeFields(?array $merge_fields) { if (is_null($merge_fields)) { - throw new \InvalidArgumentException('non-nullable merge_fields cannot be null'); + throw new InvalidArgumentException('non-nullable merge_fields cannot be null'); } $this->container['merge_fields'] = $merge_fields; @@ -906,17 +895,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The default template email message. + * @param string|null $message the default template email message * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling TemplateCreateEmbeddedDraftRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling TemplateCreateEmbeddedDraftRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -941,13 +930,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -970,10 +958,10 @@ public function getShowPreview() * * @return self */ - public function setShowPreview($show_preview) + public function setShowPreview(?bool $show_preview) { if (is_null($show_preview)) { - throw new \InvalidArgumentException('non-nullable show_preview cannot be null'); + throw new InvalidArgumentException('non-nullable show_preview cannot be null'); } $this->container['show_preview'] = $show_preview; @@ -993,14 +981,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden * * @return self */ - public function setShowProgressStepper($show_progress_stepper) + public function setShowProgressStepper(?bool $show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -1010,7 +998,7 @@ public function setShowProgressStepper($show_progress_stepper) /** * Gets signer_roles * - * @return \Dropbox\Sign\Model\SubTemplateRole[]|null + * @return SubTemplateRole[]|null */ public function getSignerRoles() { @@ -1020,14 +1008,14 @@ public function getSignerRoles() /** * Sets signer_roles * - * @param \Dropbox\Sign\Model\SubTemplateRole[]|null $signer_roles An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + * @param SubTemplateRole[]|null $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template * * @return self */ - public function setSignerRoles($signer_roles) + public function setSignerRoles(?array $signer_roles) { if (is_null($signer_roles)) { - throw new \InvalidArgumentException('non-nullable signer_roles cannot be null'); + throw new InvalidArgumentException('non-nullable signer_roles cannot be null'); } $this->container['signer_roles'] = $signer_roles; @@ -1051,10 +1039,10 @@ public function getSkipMeNow() * * @return self */ - public function setSkipMeNow($skip_me_now) + public function setSkipMeNow(?bool $skip_me_now) { if (is_null($skip_me_now)) { - throw new \InvalidArgumentException('non-nullable skip_me_now cannot be null'); + throw new InvalidArgumentException('non-nullable skip_me_now cannot be null'); } $this->container['skip_me_now'] = $skip_me_now; @@ -1074,17 +1062,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The template title (alias). + * @param string|null $subject the template title (alias) * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 200)) { - throw new \InvalidArgumentException('invalid length for $subject when calling TemplateCreateEmbeddedDraftRequest., must be smaller than or equal to 200.'); + if (mb_strlen($subject) > 200) { + throw new InvalidArgumentException('invalid length for $subject when calling TemplateCreateEmbeddedDraftRequest., must be smaller than or equal to 200.'); } $this->container['subject'] = $subject; @@ -1109,10 +1097,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1132,14 +1120,14 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title you want to assign to the SignatureRequest. + * @param string|null $title the title you want to assign to the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -1159,27 +1147,26 @@ public function getUsePreexistingFields() /** * Sets use_preexisting_fields * - * @param bool|null $use_preexisting_fields Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). + * @param bool|null $use_preexisting_fields enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`) * * @return self */ - public function setUsePreexistingFields($use_preexisting_fields) + public function setUsePreexistingFields(?bool $use_preexisting_fields) { if (is_null($use_preexisting_fields)) { - throw new \InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); + throw new InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); } $this->container['use_preexisting_fields'] = $use_preexisting_fields; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1188,11 +1175,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1203,10 +1190,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1219,11 +1204,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1231,15 +1214,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1265,5 +1248,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php index 7ef9d7a64..49266a669 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateCreateEmbeddedDraftResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateEmbeddedDraftResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateCreateEmbeddedDraftResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateEmbeddedDraftResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template' => '\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'template' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'template' => 'template', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'template' => 'setTemplate', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'template' => 'getTemplate', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateCreateEmbeddedDraftResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateCreateEmbeddedDraftResponse { /** @var TemplateCreateEmbeddedDraftResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateCreateEmbeddedDraftResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template * - * @return \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate + * @return TemplateCreateEmbeddedDraftResponseTemplate */ public function getTemplate() { @@ -332,14 +320,14 @@ public function getTemplate() /** * Sets template * - * @param \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate $template template + * @param TemplateCreateEmbeddedDraftResponseTemplate $template template * * @return self */ - public function setTemplate($template) + public function setTemplate(TemplateCreateEmbeddedDraftResponseTemplate $template) { if (is_null($template)) { - throw new \InvalidArgumentException('non-nullable template cannot be null'); + throw new InvalidArgumentException('non-nullable template cannot be null'); } $this->container['template'] = $template; @@ -349,7 +337,7 @@ public function setTemplate($template) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php index 9e1345225..44031ce16 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,73 +27,74 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateCreateEmbeddedDraftResponseTemplate Class Doc Comment * * @category Class * @description Template object with parameters: `template_id`, `edit_url`, `expires_at`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateEmbeddedDraftResponseTemplate implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateCreateEmbeddedDraftResponseTemplate implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateEmbeddedDraftResponseTemplate'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_id' => 'string', 'edit_url' => 'string', 'expires_at' => 'int', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_id' => null, 'edit_url' => null, 'expires_at' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'template_id' => false, 'edit_url' => false, 'expires_at' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,8 +119,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -131,7 +128,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +138,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,9 +147,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -161,9 +155,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'template_id', 'edit_url' => 'edit_url', 'expires_at' => 'expires_at', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'setTemplateId', 'edit_url' => 'setEditUrl', 'expires_at' => 'setExpiresAt', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'getTemplateId', 'edit_url' => 'getEditUrl', 'expires_at' => 'getExpiresAt', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -248,7 +239,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -270,34 +260,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateCreateEmbeddedDraftResponseTemplate { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateCreateEmbeddedDraftResponseTemplate { /** @var TemplateCreateEmbeddedDraftResponseTemplate */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateCreateEmbeddedDraftResponseTemplate::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,9 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -330,7 +317,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template_id * @@ -344,14 +330,14 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id The id of the Template. + * @param string|null $template_id the id of the Template * * @return self */ - public function setTemplateId($template_id) + public function setTemplateId(?string $template_id) { if (is_null($template_id)) { - throw new \InvalidArgumentException('non-nullable template_id cannot be null'); + throw new InvalidArgumentException('non-nullable template_id cannot be null'); } $this->container['template_id'] = $template_id; @@ -371,14 +357,14 @@ public function getEditUrl() /** * Sets edit_url * - * @param string|null $edit_url Link to edit the template. + * @param string|null $edit_url link to edit the template * * @return self */ - public function setEditUrl($edit_url) + public function setEditUrl(?string $edit_url) { if (is_null($edit_url)) { - throw new \InvalidArgumentException('non-nullable edit_url cannot be null'); + throw new InvalidArgumentException('non-nullable edit_url cannot be null'); } $this->container['edit_url'] = $edit_url; @@ -398,14 +384,14 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at When the link expires. + * @param int|null $expires_at when the link expires * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { - throw new \InvalidArgumentException('non-nullable expires_at cannot be null'); + throw new InvalidArgumentException('non-nullable expires_at cannot be null'); } $this->container['expires_at'] = $expires_at; @@ -415,7 +401,7 @@ public function setExpiresAt($expires_at) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null * @deprecated */ public function getWarnings() @@ -426,28 +412,27 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self * @deprecated */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -456,11 +441,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -471,10 +456,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -487,11 +470,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -499,15 +480,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -533,5 +514,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateCreateRequest.php b/sdks/php/src/Model/TemplateCreateRequest.php index 7f319bfa8..ec6890622 100644 --- a/sdks/php/src/Model/TemplateCreateRequest.php +++ b/sdks/php/src/Model/TemplateCreateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * TemplateCreateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'form_fields_per_document' => '\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]', 'signer_roles' => '\Dropbox\Sign\Model\SubTemplateRole[]', @@ -75,16 +75,16 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, \JsonSeriali 'subject' => 'string', 'test_mode' => 'bool', 'title' => 'string', - 'use_preexisting_fields' => 'bool' + 'use_preexisting_fields' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'form_fields_per_document' => null, 'signer_roles' => null, @@ -103,14 +103,14 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, \JsonSeriali 'subject' => null, 'test_mode' => null, 'title' => null, - 'use_preexisting_fields' => null + 'use_preexisting_fields' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'form_fields_per_document' => false, 'signer_roles' => false, @@ -129,14 +129,14 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, \JsonSeriali 'subject' => false, 'test_mode' => false, 'title' => false, - 'use_preexisting_fields' => false + 'use_preexisting_fields' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -161,8 +161,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -172,7 +170,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -182,7 +180,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -191,9 +189,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -202,9 +197,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -235,7 +227,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'subject', 'test_mode' => 'test_mode', 'title' => 'title', - 'use_preexisting_fields' => 'use_preexisting_fields' + 'use_preexisting_fields' => 'use_preexisting_fields', ]; /** @@ -261,7 +253,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'setSubject', 'test_mode' => 'setTestMode', 'title' => 'setTitle', - 'use_preexisting_fields' => 'setUsePreexistingFields' + 'use_preexisting_fields' => 'setUsePreexistingFields', ]; /** @@ -287,7 +279,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'getSubject', 'test_mode' => 'getTestMode', 'title' => 'getTitle', - 'use_preexisting_fields' => 'getUsePreexistingFields' + 'use_preexisting_fields' => 'getUsePreexistingFields', ]; /** @@ -331,7 +323,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -367,34 +358,33 @@ public function __construct(array $data = null) $this->setIfExists('use_preexisting_fields', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateCreateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateCreateRequest { /** @var TemplateCreateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateCreateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -441,11 +431,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets form_fields_per_document * - * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[] + * @return SubFormFieldsPerDocumentBase[] */ public function getFormFieldsPerDocument() { @@ -455,14 +444,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[] $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param SubFormFieldsPerDocumentBase[] $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument($form_fields_per_document) + public function setFormFieldsPerDocument(array $form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -472,7 +461,7 @@ public function setFormFieldsPerDocument($form_fields_per_document) /** * Gets signer_roles * - * @return \Dropbox\Sign\Model\SubTemplateRole[] + * @return SubTemplateRole[] */ public function getSignerRoles() { @@ -482,14 +471,14 @@ public function getSignerRoles() /** * Sets signer_roles * - * @param \Dropbox\Sign\Model\SubTemplateRole[] $signer_roles An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + * @param SubTemplateRole[] $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template * * @return self */ - public function setSignerRoles($signer_roles) + public function setSignerRoles(array $signer_roles) { if (is_null($signer_roles)) { - throw new \InvalidArgumentException('non-nullable signer_roles cannot be null'); + throw new InvalidArgumentException('non-nullable signer_roles cannot be null'); } $this->container['signer_roles'] = $signer_roles; @@ -499,7 +488,7 @@ public function setSignerRoles($signer_roles) /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -509,14 +498,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -540,10 +529,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -567,10 +556,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign($allow_reassign) + public function setAllowReassign(?bool $allow_reassign) { if (is_null($allow_reassign)) { - throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -580,7 +569,7 @@ public function setAllowReassign($allow_reassign) /** * Gets attachments * - * @return \Dropbox\Sign\Model\SubAttachment[]|null + * @return SubAttachment[]|null */ public function getAttachments() { @@ -590,14 +579,14 @@ public function getAttachments() /** * Sets attachments * - * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments($attachments) + public function setAttachments(?array $attachments) { if (is_null($attachments)) { - throw new \InvalidArgumentException('non-nullable attachments cannot be null'); + throw new InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -621,10 +610,10 @@ public function getCcRoles() * * @return self */ - public function setCcRoles($cc_roles) + public function setCcRoles(?array $cc_roles) { if (is_null($cc_roles)) { - throw new \InvalidArgumentException('non-nullable cc_roles cannot be null'); + throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); } $this->container['cc_roles'] = $cc_roles; @@ -648,10 +637,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(?string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -661,7 +650,7 @@ public function setClientId($client_id) /** * Gets field_options * - * @return \Dropbox\Sign\Model\SubFieldOptions|null + * @return SubFieldOptions|null */ public function getFieldOptions() { @@ -671,14 +660,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options + * @param SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions($field_options) + public function setFieldOptions(?SubFieldOptions $field_options) { if (is_null($field_options)) { - throw new \InvalidArgumentException('non-nullable field_options cannot be null'); + throw new InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -688,7 +677,7 @@ public function setFieldOptions($field_options) /** * Gets form_field_groups * - * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null + * @return SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -698,14 +687,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups($form_field_groups) + public function setFormFieldGroups(?array $form_field_groups) { if (is_null($form_field_groups)) { - throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -715,7 +704,7 @@ public function setFormFieldGroups($form_field_groups) /** * Gets form_field_rules * - * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null + * @return SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -725,14 +714,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. + * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` * * @return self */ - public function setFormFieldRules($form_field_rules) + public function setFormFieldRules(?array $form_field_rules) { if (is_null($form_field_rules)) { - throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -742,7 +731,7 @@ public function setFormFieldRules($form_field_rules) /** * Gets merge_fields * - * @return \Dropbox\Sign\Model\SubMergeField[]|null + * @return SubMergeField[]|null */ public function getMergeFields() { @@ -752,14 +741,14 @@ public function getMergeFields() /** * Sets merge_fields * - * @param \Dropbox\Sign\Model\SubMergeField[]|null $merge_fields Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. + * @param SubMergeField[]|null $merge_fields Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. * * @return self */ - public function setMergeFields($merge_fields) + public function setMergeFields(?array $merge_fields) { if (is_null($merge_fields)) { - throw new \InvalidArgumentException('non-nullable merge_fields cannot be null'); + throw new InvalidArgumentException('non-nullable merge_fields cannot be null'); } $this->container['merge_fields'] = $merge_fields; @@ -779,17 +768,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The default template email message. + * @param string|null $message the default template email message * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling TemplateCreateRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling TemplateCreateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -814,13 +803,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -839,17 +827,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The template title (alias). + * @param string|null $subject the template title (alias) * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 200)) { - throw new \InvalidArgumentException('invalid length for $subject when calling TemplateCreateRequest., must be smaller than or equal to 200.'); + if (mb_strlen($subject) > 200) { + throw new InvalidArgumentException('invalid length for $subject when calling TemplateCreateRequest., must be smaller than or equal to 200.'); } $this->container['subject'] = $subject; @@ -874,10 +862,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -897,14 +885,14 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title you want to assign to the SignatureRequest. + * @param string|null $title the title you want to assign to the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -924,27 +912,26 @@ public function getUsePreexistingFields() /** * Sets use_preexisting_fields * - * @param bool|null $use_preexisting_fields Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). + * @param bool|null $use_preexisting_fields enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`) * * @return self */ - public function setUsePreexistingFields($use_preexisting_fields) + public function setUsePreexistingFields(?bool $use_preexisting_fields) { if (is_null($use_preexisting_fields)) { - throw new \InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); + throw new InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); } $this->container['use_preexisting_fields'] = $use_preexisting_fields; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -953,11 +940,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -968,10 +955,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -984,11 +969,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -996,15 +979,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1030,5 +1013,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateCreateResponse.php b/sdks/php/src/Model/TemplateCreateResponse.php index fd01c2708..e17ce910a 100644 --- a/sdks/php/src/Model/TemplateCreateResponse.php +++ b/sdks/php/src/Model/TemplateCreateResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateCreateResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateCreateResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template' => '\Dropbox\Sign\Model\TemplateCreateResponseTemplate', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'template' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'template' => 'template', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'template' => 'setTemplate', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'template' => 'getTemplate', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateCreateResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateCreateResponse { /** @var TemplateCreateResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateCreateResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template * - * @return \Dropbox\Sign\Model\TemplateCreateResponseTemplate + * @return TemplateCreateResponseTemplate */ public function getTemplate() { @@ -332,14 +320,14 @@ public function getTemplate() /** * Sets template * - * @param \Dropbox\Sign\Model\TemplateCreateResponseTemplate $template template + * @param TemplateCreateResponseTemplate $template template * * @return self */ - public function setTemplate($template) + public function setTemplate(TemplateCreateResponseTemplate $template) { if (is_null($template)) { - throw new \InvalidArgumentException('non-nullable template cannot be null'); + throw new InvalidArgumentException('non-nullable template cannot be null'); } $this->container['template'] = $template; @@ -349,7 +337,7 @@ public function setTemplate($template) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateCreateResponseTemplate.php b/sdks/php/src/Model/TemplateCreateResponseTemplate.php index 4ab7c4a3a..199aa3f74 100644 --- a/sdks/php/src/Model/TemplateCreateResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateResponseTemplate.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,64 +27,65 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateCreateResponseTemplate Class Doc Comment * * @category Class * @description Template object with parameters: `template_id`. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateCreateResponseTemplate implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateCreateResponseTemplate implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateCreateResponseTemplate'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'template_id' => 'string' + 'template_id' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'template_id' => null + 'template_id' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'template_id' => false + 'template_id' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -111,8 +110,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -122,7 +119,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -132,7 +129,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -141,9 +138,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -152,9 +146,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -168,7 +159,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'template_id' => 'template_id' + 'template_id' => 'template_id', ]; /** @@ -177,7 +168,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'template_id' => 'setTemplateId' + 'template_id' => 'setTemplateId', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'template_id' => 'getTemplateId' + 'template_id' => 'getTemplateId', ]; /** @@ -230,7 +221,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -249,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('template_id', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateCreateResponseTemplate { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateCreateResponseTemplate { /** @var TemplateCreateResponseTemplate */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateCreateResponseTemplate::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -293,9 +282,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -309,7 +296,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template_id * @@ -323,27 +309,26 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id The id of the Template. + * @param string|null $template_id the id of the Template * * @return self */ - public function setTemplateId($template_id) + public function setTemplateId(?string $template_id) { if (is_null($template_id)) { - throw new \InvalidArgumentException('non-nullable template_id cannot be null'); + throw new InvalidArgumentException('non-nullable template_id cannot be null'); } $this->container['template_id'] = $template_id; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -352,11 +337,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -367,10 +352,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -383,11 +366,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -395,15 +376,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -429,5 +410,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateEditResponse.php b/sdks/php/src/Model/TemplateEditResponse.php index 940775371..0ef5462cf 100644 --- a/sdks/php/src/Model/TemplateEditResponse.php +++ b/sdks/php/src/Model/TemplateEditResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateEditResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateEditResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateEditResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateEditResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'template_id' => 'string' + 'template_id' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'template_id' => null + 'template_id' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'template_id' => false + 'template_id' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'template_id' => 'template_id' + 'template_id' => 'template_id', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'template_id' => 'setTemplateId' + 'template_id' => 'setTemplateId', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'template_id' => 'getTemplateId' + 'template_id' => 'getTemplateId', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('template_id', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateEditResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateEditResponse { /** @var TemplateEditResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateEditResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -311,7 +300,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template_id * @@ -325,27 +313,26 @@ public function getTemplateId() /** * Sets template_id * - * @param string $template_id The id of the Template. + * @param string $template_id the id of the Template * * @return self */ - public function setTemplateId($template_id) + public function setTemplateId(string $template_id) { if (is_null($template_id)) { - throw new \InvalidArgumentException('non-nullable template_id cannot be null'); + throw new InvalidArgumentException('non-nullable template_id cannot be null'); } $this->container['template_id'] = $template_id; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -354,11 +341,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -369,10 +356,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -385,11 +370,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -397,15 +380,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -431,5 +414,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateGetResponse.php b/sdks/php/src/Model/TemplateGetResponse.php index 6d8280c8b..45b89ba15 100644 --- a/sdks/php/src/Model/TemplateGetResponse.php +++ b/sdks/php/src/Model/TemplateGetResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateGetResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateGetResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateGetResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateGetResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template' => '\Dropbox\Sign\Model\TemplateResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'template' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'template' => 'template', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'template' => 'setTemplate', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'template' => 'getTemplate', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateGetResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateGetResponse { /** @var TemplateGetResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateGetResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template * - * @return \Dropbox\Sign\Model\TemplateResponse + * @return TemplateResponse */ public function getTemplate() { @@ -332,14 +320,14 @@ public function getTemplate() /** * Sets template * - * @param \Dropbox\Sign\Model\TemplateResponse $template template + * @param TemplateResponse $template template * * @return self */ - public function setTemplate($template) + public function setTemplate(TemplateResponse $template) { if (is_null($template)) { - throw new \InvalidArgumentException('non-nullable template cannot be null'); + throw new InvalidArgumentException('non-nullable template cannot be null'); } $this->container['template'] = $template; @@ -349,7 +337,7 @@ public function setTemplate($template) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateListResponse.php b/sdks/php/src/Model/TemplateListResponse.php index 08656a057..49974663e 100644 --- a/sdks/php/src/Model/TemplateListResponse.php +++ b/sdks/php/src/Model/TemplateListResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,69 +27,70 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateListResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateListResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateListResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateListResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'templates' => '\Dropbox\Sign\Model\TemplateResponse[]', 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'templates' => null, 'list_info' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'templates' => false, 'list_info' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -116,8 +115,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -127,7 +124,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -137,7 +134,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -146,9 +143,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -157,9 +151,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'templates' => 'templates', 'list_info' => 'list_info', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'templates' => 'setTemplates', 'list_info' => 'setListInfo', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -197,7 +188,7 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'templates' => 'getTemplates', 'list_info' => 'getListInfo', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -241,7 +232,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -262,34 +252,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateListResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateListResponse { /** @var TemplateListResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateListResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,11 +317,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets templates * - * @return \Dropbox\Sign\Model\TemplateResponse[] + * @return TemplateResponse[] */ public function getTemplates() { @@ -342,14 +330,14 @@ public function getTemplates() /** * Sets templates * - * @param \Dropbox\Sign\Model\TemplateResponse[] $templates List of templates that the API caller has access to. + * @param TemplateResponse[] $templates list of templates that the API caller has access to * * @return self */ - public function setTemplates($templates) + public function setTemplates(array $templates) { if (is_null($templates)) { - throw new \InvalidArgumentException('non-nullable templates cannot be null'); + throw new InvalidArgumentException('non-nullable templates cannot be null'); } $this->container['templates'] = $templates; @@ -359,7 +347,7 @@ public function setTemplates($templates) /** * Gets list_info * - * @return \Dropbox\Sign\Model\ListInfoResponse + * @return ListInfoResponse */ public function getListInfo() { @@ -369,14 +357,14 @@ public function getListInfo() /** * Sets list_info * - * @param \Dropbox\Sign\Model\ListInfoResponse $list_info list_info + * @param ListInfoResponse $list_info list_info * * @return self */ - public function setListInfo($list_info) + public function setListInfo(ListInfoResponse $list_info) { if (is_null($list_info)) { - throw new \InvalidArgumentException('non-nullable list_info cannot be null'); + throw new InvalidArgumentException('non-nullable list_info cannot be null'); } $this->container['list_info'] = $list_info; @@ -386,7 +374,7 @@ public function setListInfo($list_info) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -396,27 +384,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -425,11 +412,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -440,10 +427,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -456,11 +441,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -468,15 +451,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -502,5 +485,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateRemoveUserRequest.php b/sdks/php/src/Model/TemplateRemoveUserRequest.php index 79b22b8c3..d7a8582f9 100644 --- a/sdks/php/src/Model/TemplateRemoveUserRequest.php +++ b/sdks/php/src/Model/TemplateRemoveUserRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateRemoveUserRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateRemoveUserRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateRemoveUserRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateRemoveUserRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', - 'email_address' => 'string' + 'email_address' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, - 'email_address' => 'email' + 'email_address' => 'email', ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account_id' => false, - 'email_address' => false + 'email_address' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account_id' => 'account_id', - 'email_address' => 'email_address' + 'email_address' => 'email_address', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account_id' => 'setAccountId', - 'email_address' => 'setEmailAddress' + 'email_address' => 'setEmailAddress', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account_id' => 'getAccountId', - 'email_address' => 'getEmailAddress' + 'email_address' => 'getEmailAddress', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('email_address', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateRemoveUserRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateRemoveUserRequest { /** @var TemplateRemoveUserRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateRemoveUserRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -299,9 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -315,7 +302,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account_id * @@ -333,10 +319,10 @@ public function getAccountId() * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -360,23 +346,22 @@ public function getEmailAddress() * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -385,11 +370,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -400,10 +385,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -416,11 +399,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -428,15 +409,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -462,5 +443,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponse.php b/sdks/php/src/Model/TemplateResponse.php index 340595d57..6bc51cfb9 100644 --- a/sdks/php/src/Model/TemplateResponse.php +++ b/sdks/php/src/Model/TemplateResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponse Class Doc Comment * * @category Class * @description Contains information about the templates you and your team have created. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_id' => 'string', 'title' => 'string', @@ -74,16 +73,16 @@ class TemplateResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', 'named_form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', 'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]', - 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]' + 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_id' => null, 'title' => null, @@ -100,14 +99,14 @@ class TemplateResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'custom_fields' => null, 'named_form_fields' => null, 'accounts' => null, - 'attachments' => null + 'attachments' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'template_id' => false, 'title' => false, @@ -124,14 +123,14 @@ class TemplateResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'custom_fields' => true, 'named_form_fields' => true, 'accounts' => false, - 'attachments' => false + 'attachments' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -156,8 +155,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -167,7 +164,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -177,7 +174,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -186,9 +183,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -197,9 +191,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -228,7 +219,7 @@ public function isNullableSetToNull(string $property): bool 'custom_fields' => 'custom_fields', 'named_form_fields' => 'named_form_fields', 'accounts' => 'accounts', - 'attachments' => 'attachments' + 'attachments' => 'attachments', ]; /** @@ -252,7 +243,7 @@ public function isNullableSetToNull(string $property): bool 'custom_fields' => 'setCustomFields', 'named_form_fields' => 'setNamedFormFields', 'accounts' => 'setAccounts', - 'attachments' => 'setAttachments' + 'attachments' => 'setAttachments', ]; /** @@ -276,7 +267,7 @@ public function isNullableSetToNull(string $property): bool 'custom_fields' => 'getCustomFields', 'named_form_fields' => 'getNamedFormFields', 'accounts' => 'getAccounts', - 'attachments' => 'getAttachments' + 'attachments' => 'getAttachments', ]; /** @@ -320,7 +311,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -354,34 +344,33 @@ public function __construct(array $data = null) $this->setIfExists('attachments', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponse { /** @var TemplateResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -398,9 +387,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -414,7 +401,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template_id * @@ -428,14 +414,14 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id The id of the Template. + * @param string|null $template_id the id of the Template * * @return self */ - public function setTemplateId($template_id) + public function setTemplateId(?string $template_id) { if (is_null($template_id)) { - throw new \InvalidArgumentException('non-nullable template_id cannot be null'); + throw new InvalidArgumentException('non-nullable template_id cannot be null'); } $this->container['template_id'] = $template_id; @@ -459,10 +445,10 @@ public function getTitle() * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } $this->container['title'] = $title; @@ -486,10 +472,10 @@ public function getMessage() * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } $this->container['message'] = $message; @@ -509,14 +495,14 @@ public function getUpdatedAt() /** * Sets updated_at * - * @param int|null $updated_at Time the template was last updated. + * @param int|null $updated_at time the template was last updated * * @return self */ - public function setUpdatedAt($updated_at) + public function setUpdatedAt(?int $updated_at) { if (is_null($updated_at)) { - throw new \InvalidArgumentException('non-nullable updated_at cannot be null'); + throw new InvalidArgumentException('non-nullable updated_at cannot be null'); } $this->container['updated_at'] = $updated_at; @@ -540,14 +526,14 @@ public function getIsEmbedded() * * @return self */ - public function setIsEmbedded($is_embedded) + public function setIsEmbedded(?bool $is_embedded) { if (is_null($is_embedded)) { array_push($this->openAPINullablesSetToNull, 'is_embedded'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('is_embedded', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -570,14 +556,14 @@ public function getIsCreator() /** * Sets is_creator * - * @param bool|null $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member. + * @param bool|null $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member * * @return self */ - public function setIsCreator($is_creator) + public function setIsCreator(?bool $is_creator) { if (is_null($is_creator)) { - throw new \InvalidArgumentException('non-nullable is_creator cannot be null'); + throw new InvalidArgumentException('non-nullable is_creator cannot be null'); } $this->container['is_creator'] = $is_creator; @@ -597,14 +583,14 @@ public function getCanEdit() /** * Sets can_edit * - * @param bool|null $can_edit Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). + * @param bool|null $can_edit indicates whether edit rights have been granted to you by the owner (always `true` if that's you) * * @return self */ - public function setCanEdit($can_edit) + public function setCanEdit(?bool $can_edit) { if (is_null($can_edit)) { - throw new \InvalidArgumentException('non-nullable can_edit cannot be null'); + throw new InvalidArgumentException('non-nullable can_edit cannot be null'); } $this->container['can_edit'] = $can_edit; @@ -628,10 +614,10 @@ public function getIsLocked() * * @return self */ - public function setIsLocked($is_locked) + public function setIsLocked(?bool $is_locked) { if (is_null($is_locked)) { - throw new \InvalidArgumentException('non-nullable is_locked cannot be null'); + throw new InvalidArgumentException('non-nullable is_locked cannot be null'); } $this->container['is_locked'] = $is_locked; @@ -651,14 +637,14 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata The metadata attached to the template. + * @param array|null $metadata the metadata attached to the template * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } $this->container['metadata'] = $metadata; @@ -668,7 +654,7 @@ public function setMetadata($metadata) /** * Gets signer_roles * - * @return \Dropbox\Sign\Model\TemplateResponseSignerRole[]|null + * @return TemplateResponseSignerRole[]|null */ public function getSignerRoles() { @@ -678,14 +664,14 @@ public function getSignerRoles() /** * Sets signer_roles * - * @param \Dropbox\Sign\Model\TemplateResponseSignerRole[]|null $signer_roles An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + * @param TemplateResponseSignerRole[]|null $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template * * @return self */ - public function setSignerRoles($signer_roles) + public function setSignerRoles(?array $signer_roles) { if (is_null($signer_roles)) { - throw new \InvalidArgumentException('non-nullable signer_roles cannot be null'); + throw new InvalidArgumentException('non-nullable signer_roles cannot be null'); } $this->container['signer_roles'] = $signer_roles; @@ -695,7 +681,7 @@ public function setSignerRoles($signer_roles) /** * Gets cc_roles * - * @return \Dropbox\Sign\Model\TemplateResponseCCRole[]|null + * @return TemplateResponseCCRole[]|null */ public function getCcRoles() { @@ -705,14 +691,14 @@ public function getCcRoles() /** * Sets cc_roles * - * @param \Dropbox\Sign\Model\TemplateResponseCCRole[]|null $cc_roles An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + * @param TemplateResponseCCRole[]|null $cc_roles an array of the designated CC roles that must be specified when sending a SignatureRequest using this Template * * @return self */ - public function setCcRoles($cc_roles) + public function setCcRoles(?array $cc_roles) { if (is_null($cc_roles)) { - throw new \InvalidArgumentException('non-nullable cc_roles cannot be null'); + throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); } $this->container['cc_roles'] = $cc_roles; @@ -722,7 +708,7 @@ public function setCcRoles($cc_roles) /** * Gets documents * - * @return \Dropbox\Sign\Model\TemplateResponseDocument[]|null + * @return TemplateResponseDocument[]|null */ public function getDocuments() { @@ -732,14 +718,14 @@ public function getDocuments() /** * Sets documents * - * @param \Dropbox\Sign\Model\TemplateResponseDocument[]|null $documents An array describing each document associated with this Template. Includes form field data for each document. + * @param TemplateResponseDocument[]|null $documents An array describing each document associated with this Template. Includes form field data for each document. * * @return self */ - public function setDocuments($documents) + public function setDocuments(?array $documents) { if (is_null($documents)) { - throw new \InvalidArgumentException('non-nullable documents cannot be null'); + throw new InvalidArgumentException('non-nullable documents cannot be null'); } $this->container['documents'] = $documents; @@ -749,7 +735,7 @@ public function setDocuments($documents) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]|null + * @return TemplateResponseDocumentCustomFieldBase[]|null * @deprecated */ public function getCustomFields() @@ -760,19 +746,19 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]|null $custom_fields Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. * * @return self * @deprecated */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { array_push($this->openAPINullablesSetToNull, 'custom_fields'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('custom_fields', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -785,7 +771,7 @@ public function setCustomFields($custom_fields) /** * Gets named_form_fields * - * @return \Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]|null + * @return TemplateResponseDocumentFormFieldBase[]|null * @deprecated */ public function getNamedFormFields() @@ -796,19 +782,19 @@ public function getNamedFormFields() /** * Sets named_form_fields * - * @param \Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]|null $named_form_fields Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * @param TemplateResponseDocumentFormFieldBase[]|null $named_form_fields Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. * * @return self * @deprecated */ - public function setNamedFormFields($named_form_fields) + public function setNamedFormFields(?array $named_form_fields) { if (is_null($named_form_fields)) { array_push($this->openAPINullablesSetToNull, 'named_form_fields'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('named_form_fields', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -821,7 +807,7 @@ public function setNamedFormFields($named_form_fields) /** * Gets accounts * - * @return \Dropbox\Sign\Model\TemplateResponseAccount[]|null + * @return TemplateResponseAccount[]|null */ public function getAccounts() { @@ -831,14 +817,14 @@ public function getAccounts() /** * Sets accounts * - * @param \Dropbox\Sign\Model\TemplateResponseAccount[]|null $accounts An array of the Accounts that can use this Template. + * @param TemplateResponseAccount[]|null $accounts an array of the Accounts that can use this Template * * @return self */ - public function setAccounts($accounts) + public function setAccounts(?array $accounts) { if (is_null($accounts)) { - throw new \InvalidArgumentException('non-nullable accounts cannot be null'); + throw new InvalidArgumentException('non-nullable accounts cannot be null'); } $this->container['accounts'] = $accounts; @@ -848,7 +834,7 @@ public function setAccounts($accounts) /** * Gets attachments * - * @return \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null + * @return SignatureRequestResponseAttachment[]|null */ public function getAttachments() { @@ -858,27 +844,26 @@ public function getAttachments() /** * Sets attachments * - * @param \Dropbox\Sign\Model\SignatureRequestResponseAttachment[]|null $attachments Signer attachments. + * @param SignatureRequestResponseAttachment[]|null $attachments signer attachments * * @return self */ - public function setAttachments($attachments) + public function setAttachments(?array $attachments) { if (is_null($attachments)) { - throw new \InvalidArgumentException('non-nullable attachments cannot be null'); + throw new InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -887,11 +872,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -902,10 +887,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -918,11 +901,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -930,15 +911,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -964,5 +945,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseAccount.php b/sdks/php/src/Model/TemplateResponseAccount.php index 9d331d64b..47ddefabe 100644 --- a/sdks/php/src/Model/TemplateResponseAccount.php +++ b/sdks/php/src/Model/TemplateResponseAccount.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,78 +27,79 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseAccount Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseAccount implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseAccount'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'account_id' => 'string', 'email_address' => 'string', 'is_locked' => 'bool', 'is_paid_hs' => 'bool', 'is_paid_hf' => 'bool', - 'quotas' => '\Dropbox\Sign\Model\TemplateResponseAccountQuota' + 'quotas' => '\Dropbox\Sign\Model\TemplateResponseAccountQuota', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'account_id' => null, 'email_address' => null, 'is_locked' => null, 'is_paid_hs' => null, 'is_paid_hf' => null, - 'quotas' => null + 'quotas' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'account_id' => false, 'email_address' => false, 'is_locked' => false, 'is_paid_hs' => false, 'is_paid_hf' => false, - 'quotas' => false + 'quotas' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -125,8 +124,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -136,7 +133,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -146,7 +143,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -155,9 +152,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -166,9 +160,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -187,7 +178,7 @@ public function isNullableSetToNull(string $property): bool 'is_locked' => 'is_locked', 'is_paid_hs' => 'is_paid_hs', 'is_paid_hf' => 'is_paid_hf', - 'quotas' => 'quotas' + 'quotas' => 'quotas', ]; /** @@ -201,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'is_locked' => 'setIsLocked', 'is_paid_hs' => 'setIsPaidHs', 'is_paid_hf' => 'setIsPaidHf', - 'quotas' => 'setQuotas' + 'quotas' => 'setQuotas', ]; /** @@ -215,7 +206,7 @@ public function isNullableSetToNull(string $property): bool 'is_locked' => 'getIsLocked', 'is_paid_hs' => 'getIsPaidHs', 'is_paid_hf' => 'getIsPaidHf', - 'quotas' => 'getQuotas' + 'quotas' => 'getQuotas', ]; /** @@ -259,7 +250,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -283,34 +273,33 @@ public function __construct(array $data = null) $this->setIfExists('quotas', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseAccount { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseAccount { /** @var TemplateResponseAccount */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseAccount::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -327,9 +316,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -343,7 +330,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets account_id * @@ -357,14 +343,14 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id The id of the Account. + * @param string|null $account_id the id of the Account * * @return self */ - public function setAccountId($account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { - throw new \InvalidArgumentException('non-nullable account_id cannot be null'); + throw new InvalidArgumentException('non-nullable account_id cannot be null'); } $this->container['account_id'] = $account_id; @@ -384,14 +370,14 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address The email address associated with the Account. + * @param string|null $email_address the email address associated with the Account * * @return self */ - public function setEmailAddress($email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { - throw new \InvalidArgumentException('non-nullable email_address cannot be null'); + throw new InvalidArgumentException('non-nullable email_address cannot be null'); } $this->container['email_address'] = $email_address; @@ -411,14 +397,14 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool|null $is_locked Returns `true` if the user has been locked out of their account by a team admin. + * @param bool|null $is_locked returns `true` if the user has been locked out of their account by a team admin * * @return self */ - public function setIsLocked($is_locked) + public function setIsLocked(?bool $is_locked) { if (is_null($is_locked)) { - throw new \InvalidArgumentException('non-nullable is_locked cannot be null'); + throw new InvalidArgumentException('non-nullable is_locked cannot be null'); } $this->container['is_locked'] = $is_locked; @@ -438,14 +424,14 @@ public function getIsPaidHs() /** * Sets is_paid_hs * - * @param bool|null $is_paid_hs Returns `true` if the user has a paid Dropbox Sign account. + * @param bool|null $is_paid_hs returns `true` if the user has a paid Dropbox Sign account * * @return self */ - public function setIsPaidHs($is_paid_hs) + public function setIsPaidHs(?bool $is_paid_hs) { if (is_null($is_paid_hs)) { - throw new \InvalidArgumentException('non-nullable is_paid_hs cannot be null'); + throw new InvalidArgumentException('non-nullable is_paid_hs cannot be null'); } $this->container['is_paid_hs'] = $is_paid_hs; @@ -465,14 +451,14 @@ public function getIsPaidHf() /** * Sets is_paid_hf * - * @param bool|null $is_paid_hf Returns `true` if the user has a paid HelloFax account. + * @param bool|null $is_paid_hf returns `true` if the user has a paid HelloFax account * * @return self */ - public function setIsPaidHf($is_paid_hf) + public function setIsPaidHf(?bool $is_paid_hf) { if (is_null($is_paid_hf)) { - throw new \InvalidArgumentException('non-nullable is_paid_hf cannot be null'); + throw new InvalidArgumentException('non-nullable is_paid_hf cannot be null'); } $this->container['is_paid_hf'] = $is_paid_hf; @@ -482,7 +468,7 @@ public function setIsPaidHf($is_paid_hf) /** * Gets quotas * - * @return \Dropbox\Sign\Model\TemplateResponseAccountQuota|null + * @return TemplateResponseAccountQuota|null */ public function getQuotas() { @@ -492,27 +478,26 @@ public function getQuotas() /** * Sets quotas * - * @param \Dropbox\Sign\Model\TemplateResponseAccountQuota|null $quotas quotas + * @param TemplateResponseAccountQuota|null $quotas quotas * * @return self */ - public function setQuotas($quotas) + public function setQuotas(?TemplateResponseAccountQuota $quotas) { if (is_null($quotas)) { - throw new \InvalidArgumentException('non-nullable quotas cannot be null'); + throw new InvalidArgumentException('non-nullable quotas cannot be null'); } $this->container['quotas'] = $quotas; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -521,11 +506,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -536,10 +521,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -552,11 +535,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -564,15 +545,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -598,5 +579,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseAccountQuota.php b/sdks/php/src/Model/TemplateResponseAccountQuota.php index bd3ebdbe5..46386d6ec 100644 --- a/sdks/php/src/Model/TemplateResponseAccountQuota.php +++ b/sdks/php/src/Model/TemplateResponseAccountQuota.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,73 +27,74 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseAccountQuota Class Doc Comment * * @category Class * @description An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseAccountQuota implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseAccountQuota implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseAccountQuota'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'templates_left' => 'int', 'api_signature_requests_left' => 'int', 'documents_left' => 'int', - 'sms_verifications_left' => 'int' + 'sms_verifications_left' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'templates_left' => null, 'api_signature_requests_left' => null, 'documents_left' => null, - 'sms_verifications_left' => null + 'sms_verifications_left' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'templates_left' => false, 'api_signature_requests_left' => false, 'documents_left' => false, - 'sms_verifications_left' => false + 'sms_verifications_left' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -120,8 +119,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -131,7 +128,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -141,7 +138,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -150,9 +147,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -161,9 +155,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool 'templates_left' => 'templates_left', 'api_signature_requests_left' => 'api_signature_requests_left', 'documents_left' => 'documents_left', - 'sms_verifications_left' => 'sms_verifications_left' + 'sms_verifications_left' => 'sms_verifications_left', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool 'templates_left' => 'setTemplatesLeft', 'api_signature_requests_left' => 'setApiSignatureRequestsLeft', 'documents_left' => 'setDocumentsLeft', - 'sms_verifications_left' => 'setSmsVerificationsLeft' + 'sms_verifications_left' => 'setSmsVerificationsLeft', ]; /** @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'templates_left' => 'getTemplatesLeft', 'api_signature_requests_left' => 'getApiSignatureRequestsLeft', 'documents_left' => 'getDocumentsLeft', - 'sms_verifications_left' => 'getSmsVerificationsLeft' + 'sms_verifications_left' => 'getSmsVerificationsLeft', ]; /** @@ -248,7 +239,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -270,34 +260,33 @@ public function __construct(array $data = null) $this->setIfExists('sms_verifications_left', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseAccountQuota { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseAccountQuota { /** @var TemplateResponseAccountQuota */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseAccountQuota::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -314,9 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -330,7 +317,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets templates_left * @@ -344,14 +330,14 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int|null $templates_left API templates remaining. + * @param int|null $templates_left API templates remaining * * @return self */ - public function setTemplatesLeft($templates_left) + public function setTemplatesLeft(?int $templates_left) { if (is_null($templates_left)) { - throw new \InvalidArgumentException('non-nullable templates_left cannot be null'); + throw new InvalidArgumentException('non-nullable templates_left cannot be null'); } $this->container['templates_left'] = $templates_left; @@ -371,14 +357,14 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int|null $api_signature_requests_left API signature requests remaining. + * @param int|null $api_signature_requests_left API signature requests remaining * * @return self */ - public function setApiSignatureRequestsLeft($api_signature_requests_left) + public function setApiSignatureRequestsLeft(?int $api_signature_requests_left) { if (is_null($api_signature_requests_left)) { - throw new \InvalidArgumentException('non-nullable api_signature_requests_left cannot be null'); + throw new InvalidArgumentException('non-nullable api_signature_requests_left cannot be null'); } $this->container['api_signature_requests_left'] = $api_signature_requests_left; @@ -398,14 +384,14 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int|null $documents_left Signature requests remaining. + * @param int|null $documents_left signature requests remaining * * @return self */ - public function setDocumentsLeft($documents_left) + public function setDocumentsLeft(?int $documents_left) { if (is_null($documents_left)) { - throw new \InvalidArgumentException('non-nullable documents_left cannot be null'); + throw new InvalidArgumentException('non-nullable documents_left cannot be null'); } $this->container['documents_left'] = $documents_left; @@ -425,27 +411,26 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int|null $sms_verifications_left SMS verifications remaining. + * @param int|null $sms_verifications_left SMS verifications remaining * * @return self */ - public function setSmsVerificationsLeft($sms_verifications_left) + public function setSmsVerificationsLeft(?int $sms_verifications_left) { if (is_null($sms_verifications_left)) { - throw new \InvalidArgumentException('non-nullable sms_verifications_left cannot be null'); + throw new InvalidArgumentException('non-nullable sms_verifications_left cannot be null'); } $this->container['sms_verifications_left'] = $sms_verifications_left; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -454,11 +439,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -469,10 +454,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -485,11 +468,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -497,15 +478,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -531,5 +512,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseCCRole.php b/sdks/php/src/Model/TemplateResponseCCRole.php index 607b73a23..06ee33219 100644 --- a/sdks/php/src/Model/TemplateResponseCCRole.php +++ b/sdks/php/src/Model/TemplateResponseCCRole.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseCCRole Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseCCRole implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseCCRole implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseCCRole'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'name' => 'string' + 'name' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'name' => null + 'name' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'name' => false + 'name' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'name' => 'name' + 'name' => 'name', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'name' => 'setName' + 'name' => 'setName', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'name' => 'getName' + 'name' => 'getName', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('name', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseCCRole { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseCCRole { /** @var TemplateResponseCCRole */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseCCRole::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -292,9 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -308,7 +295,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -322,27 +308,26 @@ public function getName() /** * Sets name * - * @param string|null $name The name of the Role. + * @param string|null $name the name of the Role * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -351,11 +336,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -366,10 +351,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -382,11 +365,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -394,15 +375,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -428,5 +409,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocument.php b/sdks/php/src/Model/TemplateResponseDocument.php index 2c1b4beee..02a88387d 100644 --- a/sdks/php/src/Model/TemplateResponseDocument.php +++ b/sdks/php/src/Model/TemplateResponseDocument.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,78 +27,79 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseDocument Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocument implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocument'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', 'index' => 'int', 'field_groups' => '\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]', 'form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', - 'static_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]' + 'static_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, 'index' => null, 'field_groups' => null, 'form_fields' => null, 'custom_fields' => null, - 'static_fields' => null + 'static_fields' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'name' => false, 'index' => false, 'field_groups' => false, 'form_fields' => false, 'custom_fields' => false, - 'static_fields' => false + 'static_fields' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -125,8 +124,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -136,7 +133,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -146,7 +143,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -155,9 +152,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -166,9 +160,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -187,7 +178,7 @@ public function isNullableSetToNull(string $property): bool 'field_groups' => 'field_groups', 'form_fields' => 'form_fields', 'custom_fields' => 'custom_fields', - 'static_fields' => 'static_fields' + 'static_fields' => 'static_fields', ]; /** @@ -201,7 +192,7 @@ public function isNullableSetToNull(string $property): bool 'field_groups' => 'setFieldGroups', 'form_fields' => 'setFormFields', 'custom_fields' => 'setCustomFields', - 'static_fields' => 'setStaticFields' + 'static_fields' => 'setStaticFields', ]; /** @@ -215,7 +206,7 @@ public function isNullableSetToNull(string $property): bool 'field_groups' => 'getFieldGroups', 'form_fields' => 'getFormFields', 'custom_fields' => 'getCustomFields', - 'static_fields' => 'getStaticFields' + 'static_fields' => 'getStaticFields', ]; /** @@ -259,7 +250,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -283,34 +273,33 @@ public function __construct(array $data = null) $this->setIfExists('static_fields', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocument { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocument { /** @var TemplateResponseDocument */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocument::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -327,9 +316,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -343,7 +330,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -357,14 +343,14 @@ public function getName() /** * Sets name * - * @param string|null $name Name of the associated file. + * @param string|null $name name of the associated file * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -384,14 +370,14 @@ public function getIndex() /** * Sets index * - * @param int|null $index Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + * @param int|null $index document ordering, the lowest index is displayed first and the highest last (0-based indexing) * * @return self */ - public function setIndex($index) + public function setIndex(?int $index) { if (is_null($index)) { - throw new \InvalidArgumentException('non-nullable index cannot be null'); + throw new InvalidArgumentException('non-nullable index cannot be null'); } $this->container['index'] = $index; @@ -401,7 +387,7 @@ public function setIndex($index) /** * Gets field_groups * - * @return \Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]|null + * @return TemplateResponseDocumentFieldGroup[]|null */ public function getFieldGroups() { @@ -411,14 +397,14 @@ public function getFieldGroups() /** * Sets field_groups * - * @param \Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]|null $field_groups An array of Form Field Group objects. + * @param TemplateResponseDocumentFieldGroup[]|null $field_groups an array of Form Field Group objects * * @return self */ - public function setFieldGroups($field_groups) + public function setFieldGroups(?array $field_groups) { if (is_null($field_groups)) { - throw new \InvalidArgumentException('non-nullable field_groups cannot be null'); + throw new InvalidArgumentException('non-nullable field_groups cannot be null'); } $this->container['field_groups'] = $field_groups; @@ -428,7 +414,7 @@ public function setFieldGroups($field_groups) /** * Gets form_fields * - * @return \Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]|null + * @return TemplateResponseDocumentFormFieldBase[]|null */ public function getFormFields() { @@ -438,14 +424,14 @@ public function getFormFields() /** * Sets form_fields * - * @param \Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]|null $form_fields An array of Form Field objects containing the name and type of each named field. + * @param TemplateResponseDocumentFormFieldBase[]|null $form_fields an array of Form Field objects containing the name and type of each named field * * @return self */ - public function setFormFields($form_fields) + public function setFormFields(?array $form_fields) { if (is_null($form_fields)) { - throw new \InvalidArgumentException('non-nullable form_fields cannot be null'); + throw new InvalidArgumentException('non-nullable form_fields cannot be null'); } $this->container['form_fields'] = $form_fields; @@ -455,7 +441,7 @@ public function setFormFields($form_fields) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]|null + * @return TemplateResponseDocumentCustomFieldBase[]|null */ public function getCustomFields() { @@ -465,14 +451,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]|null $custom_fields An array of Form Field objects containing the name and type of each named field. + * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields an array of Form Field objects containing the name and type of each named field * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -482,7 +468,7 @@ public function setCustomFields($custom_fields) /** * Gets static_fields * - * @return \Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]|null + * @return TemplateResponseDocumentStaticFieldBase[]|null */ public function getStaticFields() { @@ -492,27 +478,26 @@ public function getStaticFields() /** * Sets static_fields * - * @param \Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]|null $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * @param TemplateResponseDocumentStaticFieldBase[]|null $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. * * @return self */ - public function setStaticFields($static_fields) + public function setStaticFields(?array $static_fields) { if (is_null($static_fields)) { - throw new \InvalidArgumentException('non-nullable static_fields cannot be null'); + throw new InvalidArgumentException('non-nullable static_fields cannot be null'); } $this->container['static_fields'] = $static_fields; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -521,11 +506,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -536,10 +521,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -552,11 +535,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -564,15 +545,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -598,5 +579,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php index 24a4a7e43..011502522 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseDocumentCustomFieldBase Class Doc Comment * * @category Class * @description An array of Form Field objects containing the name and type of each named field. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentCustomFieldBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'api_id' => 'string', @@ -68,16 +67,16 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc 'width' => 'int', 'height' => 'int', 'required' => 'bool', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'api_id' => null, @@ -88,14 +87,14 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc 'width' => null, 'height' => null, 'required' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'api_id' => false, @@ -106,14 +105,14 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc 'width' => false, 'height' => false, 'required' => false, - 'group' => true + 'group' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -138,8 +137,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -149,7 +146,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -159,7 +156,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -168,9 +165,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -179,9 +173,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'width', 'height' => 'height', 'required' => 'required', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -222,7 +213,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'setWidth', 'height' => 'setHeight', 'required' => 'setRequired', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -240,7 +231,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'getWidth', 'height' => 'getHeight', 'required' => 'getRequired', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -284,7 +275,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -315,7 +305,6 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } - public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -333,14 +322,12 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -376,7 +363,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -394,10 +380,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -417,14 +403,14 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id The unique ID for this field. + * @param string|null $api_id the unique ID for this field * * @return self */ - public function setApiId($api_id) + public function setApiId(?string $api_id) { if (is_null($api_id)) { - throw new \InvalidArgumentException('non-nullable api_id cannot be null'); + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -444,14 +430,14 @@ public function getName() /** * Sets name * - * @param string|null $name The name of the Custom Field. + * @param string|null $name the name of the Custom Field * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -475,14 +461,14 @@ public function getSigner() * * @return self */ - public function setSigner($signer) + public function setSigner(?string $signer) { if (is_null($signer)) { array_push($this->openAPINullablesSetToNull, 'signer'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signer', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -505,14 +491,14 @@ public function getX() /** * Sets x * - * @param int|null $x The horizontal offset in pixels for this form field. + * @param int|null $x the horizontal offset in pixels for this form field * * @return self */ - public function setX($x) + public function setX(?int $x) { if (is_null($x)) { - throw new \InvalidArgumentException('non-nullable x cannot be null'); + throw new InvalidArgumentException('non-nullable x cannot be null'); } $this->container['x'] = $x; @@ -532,14 +518,14 @@ public function getY() /** * Sets y * - * @param int|null $y The vertical offset in pixels for this form field. + * @param int|null $y the vertical offset in pixels for this form field * * @return self */ - public function setY($y) + public function setY(?int $y) { if (is_null($y)) { - throw new \InvalidArgumentException('non-nullable y cannot be null'); + throw new InvalidArgumentException('non-nullable y cannot be null'); } $this->container['y'] = $y; @@ -559,14 +545,14 @@ public function getWidth() /** * Sets width * - * @param int|null $width The width in pixels of this form field. + * @param int|null $width the width in pixels of this form field * * @return self */ - public function setWidth($width) + public function setWidth(?int $width) { if (is_null($width)) { - throw new \InvalidArgumentException('non-nullable width cannot be null'); + throw new InvalidArgumentException('non-nullable width cannot be null'); } $this->container['width'] = $width; @@ -586,14 +572,14 @@ public function getHeight() /** * Sets height * - * @param int|null $height The height in pixels of this form field. + * @param int|null $height the height in pixels of this form field * * @return self */ - public function setHeight($height) + public function setHeight(?int $height) { if (is_null($height)) { - throw new \InvalidArgumentException('non-nullable height cannot be null'); + throw new InvalidArgumentException('non-nullable height cannot be null'); } $this->container['height'] = $height; @@ -613,14 +599,14 @@ public function getRequired() /** * Sets required * - * @param bool|null $required Boolean showing whether or not this field is required. + * @param bool|null $required boolean showing whether or not this field is required * * @return self */ - public function setRequired($required) + public function setRequired(?bool $required) { if (is_null($required)) { - throw new \InvalidArgumentException('non-nullable required cannot be null'); + throw new InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -644,14 +630,14 @@ public function getGroup() * * @return self */ - public function setGroup($group) + public function setGroup(?string $group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -660,14 +646,13 @@ public function setGroup($group) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -676,11 +661,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -691,10 +676,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -707,11 +690,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -719,15 +700,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -753,5 +734,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php index 4b4143270..7ec8dc018 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentCustomFieldCheckbox Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentCustomFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentCustomFieldCheckbox extends TemplateResponseDocumentCustomFieldBase @@ -45,46 +44,46 @@ class TemplateResponseDocumentCustomFieldCheckbox extends TemplateResponseDocume public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentCustomFieldCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'checkbox'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentCustomFieldCheckbox { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentCustomFieldCheckbox { /** @var TemplateResponseDocumentCustomFieldCheckbox */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentCustomFieldCheckbox::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php index adef7398a..e63a73978 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentCustomFieldText Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentCustomFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentCustomFieldText extends TemplateResponseDocumentCustomFieldBase @@ -45,58 +44,58 @@ class TemplateResponseDocumentCustomFieldText extends TemplateResponseDocumentCu public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentCustomFieldText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'avg_text_length' => '\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength', 'is_multiline' => 'bool', 'original_font_size' => 'int', - 'font_family' => 'string' + 'font_family' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'avg_text_length' => null, 'is_multiline' => null, 'original_font_size' => null, - 'font_family' => null + 'font_family' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'avg_text_length' => false, 'is_multiline' => false, 'original_font_size' => false, - 'font_family' => false + 'font_family' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -121,8 +120,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -132,7 +129,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -142,7 +139,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -151,9 +148,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -162,9 +156,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool 'avg_text_length' => 'avg_text_length', 'is_multiline' => 'isMultiline', 'original_font_size' => 'originalFontSize', - 'font_family' => 'fontFamily' + 'font_family' => 'fontFamily', ]; /** @@ -195,7 +186,7 @@ public function isNullableSetToNull(string $property): bool 'avg_text_length' => 'setAvgTextLength', 'is_multiline' => 'setIsMultiline', 'original_font_size' => 'setOriginalFontSize', - 'font_family' => 'setFontFamily' + 'font_family' => 'setFontFamily', ]; /** @@ -208,7 +199,7 @@ public function isNullableSetToNull(string $property): bool 'avg_text_length' => 'getAvgTextLength', 'is_multiline' => 'getIsMultiline', 'original_font_size' => 'getOriginalFontSize', - 'font_family' => 'getFontFamily' + 'font_family' => 'getFontFamily', ]; /** @@ -252,8 +243,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -271,34 +260,33 @@ public function __construct(array $data = null) $this->setIfExists('font_family', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentCustomFieldText { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentCustomFieldText { /** @var TemplateResponseDocumentCustomFieldText */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentCustomFieldText::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -334,7 +322,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -352,10 +339,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -365,7 +352,7 @@ public function setType($type) /** * Gets avg_text_length * - * @return \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null + * @return TemplateResponseFieldAvgTextLength|null */ public function getAvgTextLength() { @@ -375,14 +362,14 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength($avg_text_length) + public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { - throw new \InvalidArgumentException('non-nullable avg_text_length cannot be null'); + throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); } $this->container['avg_text_length'] = $avg_text_length; @@ -402,14 +389,14 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline Whether this form field is multiline text. + * @param bool|null $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline($is_multiline) + public function setIsMultiline(?bool $is_multiline) { if (is_null($is_multiline)) { - throw new \InvalidArgumentException('non-nullable is_multiline cannot be null'); + throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); } $this->container['is_multiline'] = $is_multiline; @@ -429,14 +416,14 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size Original font size used in this form field's text. + * @param int|null $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize($original_font_size) + public function setOriginalFontSize(?int $original_font_size) { if (is_null($original_font_size)) { - throw new \InvalidArgumentException('non-nullable original_font_size cannot be null'); + throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); } $this->container['original_font_size'] = $original_font_size; @@ -456,27 +443,26 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family Font family used in this form field's text. + * @param string|null $font_family font family used in this form field's text * * @return self */ - public function setFontFamily($font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { - throw new \InvalidArgumentException('non-nullable font_family cannot be null'); + throw new InvalidArgumentException('non-nullable font_family cannot be null'); } $this->container['font_family'] = $font_family; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -485,11 +471,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -500,10 +486,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -516,11 +500,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -528,15 +510,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -562,5 +544,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php index cb478b40e..541714841 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFieldGroup Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocumentFieldGroup implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseDocumentFieldGroup implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFieldGroup'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', - 'rule' => '\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule' + 'rule' => '\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, - 'rule' => null + 'rule' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'name' => false, - 'rule' => false + 'rule' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'rule' => 'rule' + 'rule' => 'rule', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'rule' => 'setRule' + 'rule' => 'setRule', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'rule' => 'getRule' + 'rule' => 'getRule', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('rule', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentFieldGroup { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentFieldGroup { /** @var TemplateResponseDocumentFieldGroup */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentFieldGroup::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -299,9 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -315,7 +302,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -329,14 +315,14 @@ public function getName() /** * Sets name * - * @param string|null $name The name of the form field group. + * @param string|null $name the name of the form field group * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -346,7 +332,7 @@ public function setName($name) /** * Gets rule * - * @return \Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule|null + * @return TemplateResponseDocumentFieldGroupRule|null */ public function getRule() { @@ -356,27 +342,26 @@ public function getRule() /** * Sets rule * - * @param \Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule|null $rule rule + * @param TemplateResponseDocumentFieldGroupRule|null $rule rule * * @return self */ - public function setRule($rule) + public function setRule(?TemplateResponseDocumentFieldGroupRule $rule) { if (is_null($rule)) { - throw new \InvalidArgumentException('non-nullable rule cannot be null'); + throw new InvalidArgumentException('non-nullable rule cannot be null'); } $this->container['rule'] = $rule; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -385,11 +370,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -400,10 +385,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -416,11 +399,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -428,15 +409,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -462,5 +443,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php index c217baeee..1bd31bde9 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,67 +27,68 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFieldGroupRule Class Doc Comment * * @category Class * @description The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocumentFieldGroupRule implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseDocumentFieldGroupRule implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFieldGroupRule'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'requirement' => 'string', - 'group_label' => 'string' + 'group_label' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'requirement' => null, - 'group_label' => null + 'group_label' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'requirement' => false, - 'group_label' => false + 'group_label' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -172,7 +163,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'requirement' => 'requirement', - 'group_label' => 'groupLabel' + 'group_label' => 'groupLabel', ]; /** @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'requirement' => 'setRequirement', - 'group_label' => 'setGroupLabel' + 'group_label' => 'setGroupLabel', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'requirement' => 'getRequirement', - 'group_label' => 'getGroupLabel' + 'group_label' => 'getGroupLabel', ]; /** @@ -236,7 +227,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -256,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('group_label', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentFieldGroupRule { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentFieldGroupRule { /** @var TemplateResponseDocumentFieldGroupRule */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentFieldGroupRule::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,9 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -316,7 +303,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets requirement * @@ -334,10 +320,10 @@ public function getRequirement() * * @return self */ - public function setRequirement($requirement) + public function setRequirement(?string $requirement) { if (is_null($requirement)) { - throw new \InvalidArgumentException('non-nullable requirement cannot be null'); + throw new InvalidArgumentException('non-nullable requirement cannot be null'); } $this->container['requirement'] = $requirement; @@ -361,23 +347,22 @@ public function getGroupLabel() * * @return self */ - public function setGroupLabel($group_label) + public function setGroupLabel(?string $group_label) { if (is_null($group_label)) { - throw new \InvalidArgumentException('non-nullable group_label cannot be null'); + throw new InvalidArgumentException('non-nullable group_label cannot be null'); } $this->container['group_label'] = $group_label; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -386,11 +371,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -401,10 +386,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -417,11 +400,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -429,15 +410,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -463,5 +444,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php index ce6910ba5..ecc03a7db 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFormFieldBase Class Doc Comment * * @category Class * @description An array of Form Field objects containing the name and type of each named field. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'api_id' => 'string', @@ -67,16 +66,16 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce 'y' => 'int', 'width' => 'int', 'height' => 'int', - 'required' => 'bool' + 'required' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'api_id' => null, @@ -86,14 +85,14 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce 'y' => null, 'width' => null, 'height' => null, - 'required' => null + 'required' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'api_id' => false, @@ -103,14 +102,14 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce 'y' => false, 'width' => false, 'height' => false, - 'required' => false + 'required' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -135,8 +134,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -146,7 +143,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -156,7 +153,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -165,9 +162,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -176,9 +170,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -200,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'y' => 'y', 'width' => 'width', 'height' => 'height', - 'required' => 'required' + 'required' => 'required', ]; /** @@ -217,7 +208,7 @@ public function isNullableSetToNull(string $property): bool 'y' => 'setY', 'width' => 'setWidth', 'height' => 'setHeight', - 'required' => 'setRequired' + 'required' => 'setRequired', ]; /** @@ -234,7 +225,7 @@ public function isNullableSetToNull(string $property): bool 'y' => 'getY', 'width' => 'getWidth', 'height' => 'getHeight', - 'required' => 'getRequired' + 'required' => 'getRequired', ]; /** @@ -278,7 +269,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -308,7 +298,6 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } - public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -344,14 +333,12 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -387,7 +374,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -405,10 +391,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -428,14 +414,14 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id A unique id for the form field. + * @param string|null $api_id a unique id for the form field * * @return self */ - public function setApiId($api_id) + public function setApiId(?string $api_id) { if (is_null($api_id)) { - throw new \InvalidArgumentException('non-nullable api_id cannot be null'); + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -455,14 +441,14 @@ public function getName() /** * Sets name * - * @param string|null $name The name of the form field. + * @param string|null $name the name of the form field * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -482,14 +468,14 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer The signer of the Form Field. + * @param string|null $signer the signer of the Form Field * * @return self */ - public function setSigner($signer) + public function setSigner(?string $signer) { if (is_null($signer)) { - throw new \InvalidArgumentException('non-nullable signer cannot be null'); + throw new InvalidArgumentException('non-nullable signer cannot be null'); } $this->container['signer'] = $signer; @@ -509,14 +495,14 @@ public function getX() /** * Sets x * - * @param int|null $x The horizontal offset in pixels for this form field. + * @param int|null $x the horizontal offset in pixels for this form field * * @return self */ - public function setX($x) + public function setX(?int $x) { if (is_null($x)) { - throw new \InvalidArgumentException('non-nullable x cannot be null'); + throw new InvalidArgumentException('non-nullable x cannot be null'); } $this->container['x'] = $x; @@ -536,14 +522,14 @@ public function getY() /** * Sets y * - * @param int|null $y The vertical offset in pixels for this form field. + * @param int|null $y the vertical offset in pixels for this form field * * @return self */ - public function setY($y) + public function setY(?int $y) { if (is_null($y)) { - throw new \InvalidArgumentException('non-nullable y cannot be null'); + throw new InvalidArgumentException('non-nullable y cannot be null'); } $this->container['y'] = $y; @@ -563,14 +549,14 @@ public function getWidth() /** * Sets width * - * @param int|null $width The width in pixels of this form field. + * @param int|null $width the width in pixels of this form field * * @return self */ - public function setWidth($width) + public function setWidth(?int $width) { if (is_null($width)) { - throw new \InvalidArgumentException('non-nullable width cannot be null'); + throw new InvalidArgumentException('non-nullable width cannot be null'); } $this->container['width'] = $width; @@ -590,14 +576,14 @@ public function getHeight() /** * Sets height * - * @param int|null $height The height in pixels of this form field. + * @param int|null $height the height in pixels of this form field * * @return self */ - public function setHeight($height) + public function setHeight(?int $height) { if (is_null($height)) { - throw new \InvalidArgumentException('non-nullable height cannot be null'); + throw new InvalidArgumentException('non-nullable height cannot be null'); } $this->container['height'] = $height; @@ -617,27 +603,26 @@ public function getRequired() /** * Sets required * - * @param bool|null $required Boolean showing whether or not this field is required. + * @param bool|null $required boolean showing whether or not this field is required * * @return self */ - public function setRequired($required) + public function setRequired(?bool $required) { if (is_null($required)) { - throw new \InvalidArgumentException('non-nullable required cannot be null'); + throw new InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -646,11 +631,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -661,10 +646,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -677,11 +660,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -689,15 +670,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -723,5 +704,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php index 5ef9aafc1..a30010fc1 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFormFieldCheckbox Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocumentFormFieldBase @@ -45,49 +44,49 @@ class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocument public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => true + 'group' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,8 +111,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -123,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,9 +139,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -153,9 +147,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -190,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -234,8 +225,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -250,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldCheckbox { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentFormFieldCheckbox { /** @var TemplateResponseDocumentFormFieldCheckbox */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldCheckbox::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -313,7 +301,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -331,10 +318,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -358,14 +345,14 @@ public function getGroup() * * @return self */ - public function setGroup($group) + public function setGroup(?string $group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -374,14 +361,13 @@ public function setGroup($group) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -390,11 +376,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -405,10 +391,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -421,11 +405,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -433,15 +415,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -467,5 +449,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php index b3c0c7c5e..bd6072350 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFormFieldDateSigned Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocumentFormFieldBase @@ -45,49 +44,49 @@ class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocume public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldDateSigned'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => true + 'group' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,8 +111,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -123,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,9 +139,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -153,9 +147,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -190,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -234,8 +225,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -250,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldDateSigned { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentFormFieldDateSigned { /** @var TemplateResponseDocumentFormFieldDateSigned */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldDateSigned::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -313,7 +301,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -331,10 +318,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -358,14 +345,14 @@ public function getGroup() * * @return self */ - public function setGroup($group) + public function setGroup(?string $group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -374,14 +361,13 @@ public function setGroup($group) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -390,11 +376,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -405,10 +391,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -421,11 +405,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -433,15 +415,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -467,5 +449,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php index 3e04ad34f..3e4a827da 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFormFieldDropdown Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocumentFormFieldBase @@ -45,49 +44,49 @@ class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocument public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldDropdown'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => true + 'group' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,8 +111,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -123,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,9 +139,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -153,9 +147,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -190,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -234,8 +225,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -250,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldDropdown { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentFormFieldDropdown { /** @var TemplateResponseDocumentFormFieldDropdown */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldDropdown::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -313,7 +301,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -331,10 +318,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -358,14 +345,14 @@ public function getGroup() * * @return self */ - public function setGroup($group) + public function setGroup(?string $group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -374,14 +361,13 @@ public function setGroup($group) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -390,11 +376,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -405,10 +391,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -421,11 +405,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -433,15 +415,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -467,5 +449,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php index 38ab2d6db..687269f79 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFormFieldHyperlink Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumentFormFieldBase @@ -45,61 +44,61 @@ class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumen public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldHyperlink'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'avg_text_length' => '\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength', 'is_multiline' => 'bool', 'original_font_size' => 'int', 'font_family' => 'string', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'avg_text_length' => null, 'is_multiline' => null, 'original_font_size' => null, 'font_family' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'avg_text_length' => false, 'is_multiline' => false, 'original_font_size' => false, 'font_family' => false, - 'group' => true + 'group' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -124,8 +123,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -135,7 +132,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -145,7 +142,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -154,9 +151,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -165,9 +159,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -186,7 +177,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'isMultiline', 'original_font_size' => 'originalFontSize', 'font_family' => 'fontFamily', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -200,7 +191,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'setIsMultiline', 'original_font_size' => 'setOriginalFontSize', 'font_family' => 'setFontFamily', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -214,7 +205,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'getIsMultiline', 'original_font_size' => 'getOriginalFontSize', 'font_family' => 'getFontFamily', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -258,8 +249,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -278,34 +267,33 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldHyperlink { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentFormFieldHyperlink { /** @var TemplateResponseDocumentFormFieldHyperlink */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldHyperlink::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -341,7 +329,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -359,10 +346,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -372,7 +359,7 @@ public function setType($type) /** * Gets avg_text_length * - * @return \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null + * @return TemplateResponseFieldAvgTextLength|null */ public function getAvgTextLength() { @@ -382,14 +369,14 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength($avg_text_length) + public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { - throw new \InvalidArgumentException('non-nullable avg_text_length cannot be null'); + throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); } $this->container['avg_text_length'] = $avg_text_length; @@ -409,14 +396,14 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline Whether this form field is multiline text. + * @param bool|null $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline($is_multiline) + public function setIsMultiline(?bool $is_multiline) { if (is_null($is_multiline)) { - throw new \InvalidArgumentException('non-nullable is_multiline cannot be null'); + throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); } $this->container['is_multiline'] = $is_multiline; @@ -436,14 +423,14 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size Original font size used in this form field's text. + * @param int|null $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize($original_font_size) + public function setOriginalFontSize(?int $original_font_size) { if (is_null($original_font_size)) { - throw new \InvalidArgumentException('non-nullable original_font_size cannot be null'); + throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); } $this->container['original_font_size'] = $original_font_size; @@ -463,14 +450,14 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family Font family used in this form field's text. + * @param string|null $font_family font family used in this form field's text * * @return self */ - public function setFontFamily($font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { - throw new \InvalidArgumentException('non-nullable font_family cannot be null'); + throw new InvalidArgumentException('non-nullable font_family cannot be null'); } $this->container['font_family'] = $font_family; @@ -494,14 +481,14 @@ public function getGroup() * * @return self */ - public function setGroup($group) + public function setGroup(?string $group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -510,14 +497,13 @@ public function setGroup($group) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -526,11 +512,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -541,10 +527,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -557,11 +541,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -569,15 +551,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -603,5 +585,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php index 207f3564a..101a6e955 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFormFieldInitials Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocumentFormFieldBase @@ -45,49 +44,49 @@ class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocument public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldInitials'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => true + 'group' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,8 +111,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -123,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,9 +139,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -153,9 +147,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -190,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -234,8 +225,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -250,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldInitials { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentFormFieldInitials { /** @var TemplateResponseDocumentFormFieldInitials */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldInitials::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -313,7 +301,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -331,10 +318,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -358,14 +345,14 @@ public function getGroup() * * @return self */ - public function setGroup($group) + public function setGroup(?string $group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -374,14 +361,13 @@ public function setGroup($group) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -390,11 +376,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -405,10 +391,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -421,11 +405,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -433,15 +415,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -467,5 +449,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php index cd5a776ce..8fd494678 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFormFieldRadio Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFormFieldBase @@ -45,49 +44,49 @@ class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFor public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldRadio'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => false + 'group' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,8 +111,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -123,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,9 +139,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -153,9 +147,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -190,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -234,8 +225,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -250,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldRadio { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentFormFieldRadio { /** @var TemplateResponseDocumentFormFieldRadio */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldRadio::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -316,7 +304,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -334,10 +321,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -361,23 +348,22 @@ public function getGroup() * * @return self */ - public function setGroup($group) + public function setGroup(string $group) { if (is_null($group)) { - throw new \InvalidArgumentException('non-nullable group cannot be null'); + throw new InvalidArgumentException('non-nullable group cannot be null'); } $this->container['group'] = $group; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -386,11 +372,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -401,10 +387,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -417,11 +401,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -429,15 +411,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -463,5 +445,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php index 98bd3a199..777777464 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFormFieldSignature Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumentFormFieldBase @@ -45,49 +44,49 @@ class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumen public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldSignature'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, - 'group' => true + 'group' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -112,8 +111,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -123,7 +120,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -133,7 +130,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -142,9 +139,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -153,9 +147,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -170,7 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -180,7 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -190,7 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -234,8 +225,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -250,34 +239,33 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldSignature { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentFormFieldSignature { /** @var TemplateResponseDocumentFormFieldSignature */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldSignature::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -313,7 +301,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -331,10 +318,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -358,14 +345,14 @@ public function getGroup() * * @return self */ - public function setGroup($group) + public function setGroup(?string $group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -374,14 +361,13 @@ public function setGroup($group) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -390,11 +376,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -405,10 +391,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -421,11 +405,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -433,15 +415,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -467,5 +449,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php index 50566ad74..42c15b9ed 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentFormFieldText Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentFormFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentFormFieldBase @@ -45,17 +44,17 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentFormFieldText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'avg_text_length' => '\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength', @@ -63,16 +62,16 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => 'int', 'font_family' => 'string', 'validation_type' => 'string', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'avg_text_length' => null, @@ -80,14 +79,14 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => null, 'font_family' => null, 'validation_type' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'avg_text_length' => false, @@ -95,14 +94,14 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => false, 'font_family' => false, 'validation_type' => true, - 'group' => true + 'group' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -127,8 +126,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -138,7 +135,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -148,7 +145,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -157,9 +154,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -168,9 +162,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -190,7 +181,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'originalFontSize', 'font_family' => 'fontFamily', 'validation_type' => 'validation_type', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -205,7 +196,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'setOriginalFontSize', 'font_family' => 'setFontFamily', 'validation_type' => 'setValidationType', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -220,7 +211,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'getOriginalFontSize', 'font_family' => 'getFontFamily', 'validation_type' => 'getValidationType', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -296,7 +287,6 @@ public function getValidationTypeAllowableValues() ]; } - /** * Constructor * @@ -316,34 +306,33 @@ public function __construct(array $data = null) $this->setIfExists('group', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentFormFieldText { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentFormFieldText { /** @var TemplateResponseDocumentFormFieldText */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentFormFieldText::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -388,7 +377,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -406,10 +394,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -419,7 +407,7 @@ public function setType($type) /** * Gets avg_text_length * - * @return \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null + * @return TemplateResponseFieldAvgTextLength|null */ public function getAvgTextLength() { @@ -429,14 +417,14 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param \Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength($avg_text_length) + public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { - throw new \InvalidArgumentException('non-nullable avg_text_length cannot be null'); + throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); } $this->container['avg_text_length'] = $avg_text_length; @@ -456,14 +444,14 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline Whether this form field is multiline text. + * @param bool|null $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline($is_multiline) + public function setIsMultiline(?bool $is_multiline) { if (is_null($is_multiline)) { - throw new \InvalidArgumentException('non-nullable is_multiline cannot be null'); + throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); } $this->container['is_multiline'] = $is_multiline; @@ -483,14 +471,14 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size Original font size used in this form field's text. + * @param int|null $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize($original_font_size) + public function setOriginalFontSize(?int $original_font_size) { if (is_null($original_font_size)) { - throw new \InvalidArgumentException('non-nullable original_font_size cannot be null'); + throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); } $this->container['original_font_size'] = $original_font_size; @@ -510,14 +498,14 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family Font family used in this form field's text. + * @param string|null $font_family font family used in this form field's text * * @return self */ - public function setFontFamily($font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { - throw new \InvalidArgumentException('non-nullable font_family cannot be null'); + throw new InvalidArgumentException('non-nullable font_family cannot be null'); } $this->container['font_family'] = $font_family; @@ -541,21 +529,21 @@ public function getValidationType() * * @return self */ - public function setValidationType($validation_type) + public function setValidationType(?string $validation_type) { if (is_null($validation_type)) { array_push($this->openAPINullablesSetToNull, 'validation_type'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('validation_type', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } } $allowedValues = $this->getValidationTypeAllowableValues(); if (!is_null($validation_type) && !in_array($validation_type, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'validation_type', must be one of '%s'", $validation_type, @@ -585,14 +573,14 @@ public function getGroup() * * @return self */ - public function setGroup($group) + public function setGroup(?string $group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -601,14 +589,13 @@ public function setGroup($group) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -617,11 +604,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -632,10 +619,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -648,11 +633,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -660,15 +643,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -694,5 +677,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php index 6499e20b8..bd18e1847 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseDocumentStaticFieldBase Class Doc Comment * * @category Class * @description An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = 'type'; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldBase'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'api_id' => 'string', @@ -68,16 +67,16 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc 'width' => 'int', 'height' => 'int', 'required' => 'bool', - 'group' => 'string' + 'group' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'api_id' => null, @@ -88,14 +87,14 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc 'width' => null, 'height' => null, 'required' => null, - 'group' => null + 'group' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'api_id' => false, @@ -106,14 +105,14 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc 'width' => false, 'height' => false, 'required' => false, - 'group' => true + 'group' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -138,8 +137,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -149,7 +146,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -159,7 +156,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -168,9 +165,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -179,9 +173,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -204,7 +195,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'width', 'height' => 'height', 'required' => 'required', - 'group' => 'group' + 'group' => 'group', ]; /** @@ -222,7 +213,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'setWidth', 'height' => 'setHeight', 'required' => 'setRequired', - 'group' => 'setGroup' + 'group' => 'setGroup', ]; /** @@ -240,7 +231,7 @@ public function isNullableSetToNull(string $property): bool 'width' => 'getWidth', 'height' => 'getHeight', 'required' => 'getRequired', - 'group' => 'getGroup' + 'group' => 'getGroup', ]; /** @@ -284,7 +275,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -315,7 +305,6 @@ public function __construct(array $data = null) $this->container['type'] = static::$openAPIModelName; } - public static function discriminatorClassName(array $data): ?string { if (!array_key_exists('type', $data)) { @@ -351,14 +340,12 @@ public static function discriminatorClassName(array $data): ?string } /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -394,7 +381,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -412,10 +398,10 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; @@ -435,14 +421,14 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id A unique id for the static field. + * @param string|null $api_id a unique id for the static field * * @return self */ - public function setApiId($api_id) + public function setApiId(?string $api_id) { if (is_null($api_id)) { - throw new \InvalidArgumentException('non-nullable api_id cannot be null'); + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } $this->container['api_id'] = $api_id; @@ -462,14 +448,14 @@ public function getName() /** * Sets name * - * @param string|null $name The name of the static field. + * @param string|null $name the name of the static field * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -489,14 +475,14 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer The signer of the Static Field. + * @param string|null $signer the signer of the Static Field * * @return self */ - public function setSigner($signer) + public function setSigner(?string $signer) { if (is_null($signer)) { - throw new \InvalidArgumentException('non-nullable signer cannot be null'); + throw new InvalidArgumentException('non-nullable signer cannot be null'); } $this->container['signer'] = $signer; @@ -516,14 +502,14 @@ public function getX() /** * Sets x * - * @param int|null $x The horizontal offset in pixels for this static field. + * @param int|null $x the horizontal offset in pixels for this static field * * @return self */ - public function setX($x) + public function setX(?int $x) { if (is_null($x)) { - throw new \InvalidArgumentException('non-nullable x cannot be null'); + throw new InvalidArgumentException('non-nullable x cannot be null'); } $this->container['x'] = $x; @@ -543,14 +529,14 @@ public function getY() /** * Sets y * - * @param int|null $y The vertical offset in pixels for this static field. + * @param int|null $y the vertical offset in pixels for this static field * * @return self */ - public function setY($y) + public function setY(?int $y) { if (is_null($y)) { - throw new \InvalidArgumentException('non-nullable y cannot be null'); + throw new InvalidArgumentException('non-nullable y cannot be null'); } $this->container['y'] = $y; @@ -570,14 +556,14 @@ public function getWidth() /** * Sets width * - * @param int|null $width The width in pixels of this static field. + * @param int|null $width the width in pixels of this static field * * @return self */ - public function setWidth($width) + public function setWidth(?int $width) { if (is_null($width)) { - throw new \InvalidArgumentException('non-nullable width cannot be null'); + throw new InvalidArgumentException('non-nullable width cannot be null'); } $this->container['width'] = $width; @@ -597,14 +583,14 @@ public function getHeight() /** * Sets height * - * @param int|null $height The height in pixels of this static field. + * @param int|null $height the height in pixels of this static field * * @return self */ - public function setHeight($height) + public function setHeight(?int $height) { if (is_null($height)) { - throw new \InvalidArgumentException('non-nullable height cannot be null'); + throw new InvalidArgumentException('non-nullable height cannot be null'); } $this->container['height'] = $height; @@ -624,14 +610,14 @@ public function getRequired() /** * Sets required * - * @param bool|null $required Boolean showing whether or not this field is required. + * @param bool|null $required boolean showing whether or not this field is required * * @return self */ - public function setRequired($required) + public function setRequired(?bool $required) { if (is_null($required)) { - throw new \InvalidArgumentException('non-nullable required cannot be null'); + throw new InvalidArgumentException('non-nullable required cannot be null'); } $this->container['required'] = $required; @@ -655,14 +641,14 @@ public function getGroup() * * @return self */ - public function setGroup($group) + public function setGroup(?string $group) { if (is_null($group)) { array_push($this->openAPINullablesSetToNull, 'group'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('group', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -671,14 +657,13 @@ public function setGroup($group) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -687,11 +672,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -702,10 +687,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -718,11 +701,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -730,15 +711,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -764,5 +745,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php index 8cb4bd718..9739d2e05 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentStaticFieldCheckbox Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldCheckbox extends TemplateResponseDocumentStaticFieldBase @@ -45,46 +44,46 @@ class TemplateResponseDocumentStaticFieldCheckbox extends TemplateResponseDocume public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldCheckbox'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'checkbox'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldCheckbox { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentStaticFieldCheckbox { /** @var TemplateResponseDocumentStaticFieldCheckbox */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldCheckbox::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php index 4806361ba..911febf8d 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentStaticFieldDateSigned Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldDateSigned extends TemplateResponseDocumentStaticFieldBase @@ -45,46 +44,46 @@ class TemplateResponseDocumentStaticFieldDateSigned extends TemplateResponseDocu public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldDateSigned'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'date_signed'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldDateSigned { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentStaticFieldDateSigned { /** @var TemplateResponseDocumentStaticFieldDateSigned */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldDateSigned::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php index f0ca4abc2..6022f9289 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentStaticFieldDropdown Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldDropdown extends TemplateResponseDocumentStaticFieldBase @@ -45,46 +44,46 @@ class TemplateResponseDocumentStaticFieldDropdown extends TemplateResponseDocume public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldDropdown'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'dropdown'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldDropdown { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentStaticFieldDropdown { /** @var TemplateResponseDocumentStaticFieldDropdown */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldDropdown::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php index 9d87a0c0f..246bea450 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentStaticFieldHyperlink Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldHyperlink extends TemplateResponseDocumentStaticFieldBase @@ -45,46 +44,46 @@ class TemplateResponseDocumentStaticFieldHyperlink extends TemplateResponseDocum public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldHyperlink'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'hyperlink'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldHyperlink { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentStaticFieldHyperlink { /** @var TemplateResponseDocumentStaticFieldHyperlink */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldHyperlink::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php index 9925dd541..339b3a2a5 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentStaticFieldInitials Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldInitials extends TemplateResponseDocumentStaticFieldBase @@ -45,46 +44,46 @@ class TemplateResponseDocumentStaticFieldInitials extends TemplateResponseDocume public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldInitials'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'initials'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldInitials { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentStaticFieldInitials { /** @var TemplateResponseDocumentStaticFieldInitials */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldInitials::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php index b109c83ce..8dc139712 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentStaticFieldRadio Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldRadio extends TemplateResponseDocumentStaticFieldBase @@ -45,46 +44,46 @@ class TemplateResponseDocumentStaticFieldRadio extends TemplateResponseDocumentS public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldRadio'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'radio'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldRadio { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentStaticFieldRadio { /** @var TemplateResponseDocumentStaticFieldRadio */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldRadio::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php index 8f6a1b815..c86d1c9a3 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentStaticFieldSignature Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldSignature extends TemplateResponseDocumentStaticFieldBase @@ -45,46 +44,46 @@ class TemplateResponseDocumentStaticFieldSignature extends TemplateResponseDocum public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldSignature'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'signature'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldSignature { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentStaticFieldSignature { /** @var TemplateResponseDocumentStaticFieldSignature */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldSignature::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php index 538ad2312..ec89541e3 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -28,16 +26,17 @@ */ namespace Dropbox\Sign\Model; -use \Dropbox\Sign\ObjectSerializer; + +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use ReturnTypeWillChange; /** * TemplateResponseDocumentStaticFieldText Class Doc Comment * * @category Class * @description This class extends `TemplateResponseDocumentStaticFieldBase` - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ class TemplateResponseDocumentStaticFieldText extends TemplateResponseDocumentStaticFieldBase @@ -45,46 +44,46 @@ class TemplateResponseDocumentStaticFieldText extends TemplateResponseDocumentSt public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseDocumentStaticFieldText'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'type' => 'string' + 'type' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'type' => null + 'type' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'type' => false + 'type' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -109,8 +108,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -120,7 +117,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -130,7 +127,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -139,9 +136,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -150,9 +144,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -166,7 +157,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type' + 'type' => 'type', ]; /** @@ -175,7 +166,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType' + 'type' => 'setType', ]; /** @@ -184,7 +175,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType' + 'type' => 'getType', ]; /** @@ -228,8 +219,6 @@ public function getModelName() return self::$openAPIModelName; } - - /** * Constructor * @@ -243,34 +232,33 @@ public function __construct(array $data = null) $this->setIfExists('type', $data ?? [], 'text'); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseDocumentStaticFieldText { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseDocumentStaticFieldText { /** @var TemplateResponseDocumentStaticFieldText */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseDocumentStaticFieldText::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -306,7 +294,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -324,23 +311,22 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $this->container['type'] = $type; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -349,11 +335,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -364,10 +350,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -380,11 +364,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -392,15 +374,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -426,5 +408,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php index 60e811df9..9277db26a 100644 --- a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php +++ b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,67 +27,68 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseFieldAvgTextLength Class Doc Comment * * @category Class * @description Average text length in this field. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseFieldAvgTextLength implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseFieldAvgTextLength implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseFieldAvgTextLength'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'num_lines' => 'int', - 'num_chars_per_line' => 'int' + 'num_chars_per_line' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'num_lines' => null, - 'num_chars_per_line' => null + 'num_chars_per_line' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'num_lines' => false, - 'num_chars_per_line' => false + 'num_chars_per_line' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -172,7 +163,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'num_lines' => 'num_lines', - 'num_chars_per_line' => 'num_chars_per_line' + 'num_chars_per_line' => 'num_chars_per_line', ]; /** @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'num_lines' => 'setNumLines', - 'num_chars_per_line' => 'setNumCharsPerLine' + 'num_chars_per_line' => 'setNumCharsPerLine', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'num_lines' => 'getNumLines', - 'num_chars_per_line' => 'getNumCharsPerLine' + 'num_chars_per_line' => 'getNumCharsPerLine', ]; /** @@ -236,7 +227,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -256,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('num_chars_per_line', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseFieldAvgTextLength { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseFieldAvgTextLength { /** @var TemplateResponseFieldAvgTextLength */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseFieldAvgTextLength::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,9 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -316,7 +303,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets num_lines * @@ -330,14 +316,14 @@ public function getNumLines() /** * Sets num_lines * - * @param int|null $num_lines Number of lines. + * @param int|null $num_lines number of lines * * @return self */ - public function setNumLines($num_lines) + public function setNumLines(?int $num_lines) { if (is_null($num_lines)) { - throw new \InvalidArgumentException('non-nullable num_lines cannot be null'); + throw new InvalidArgumentException('non-nullable num_lines cannot be null'); } $this->container['num_lines'] = $num_lines; @@ -357,27 +343,26 @@ public function getNumCharsPerLine() /** * Sets num_chars_per_line * - * @param int|null $num_chars_per_line Number of characters per line. + * @param int|null $num_chars_per_line number of characters per line * * @return self */ - public function setNumCharsPerLine($num_chars_per_line) + public function setNumCharsPerLine(?int $num_chars_per_line) { if (is_null($num_chars_per_line)) { - throw new \InvalidArgumentException('non-nullable num_chars_per_line cannot be null'); + throw new InvalidArgumentException('non-nullable num_chars_per_line cannot be null'); } $this->container['num_chars_per_line'] = $num_chars_per_line; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -386,11 +371,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -401,10 +386,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -417,11 +400,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -429,15 +410,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -463,5 +444,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateResponseSignerRole.php b/sdks/php/src/Model/TemplateResponseSignerRole.php index 4ab747fa4..98a80c6e0 100644 --- a/sdks/php/src/Model/TemplateResponseSignerRole.php +++ b/sdks/php/src/Model/TemplateResponseSignerRole.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateResponseSignerRole Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateResponseSignerRole implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateResponseSignerRole implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateResponseSignerRole'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'name' => 'string', - 'order' => 'int' + 'order' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'name' => null, - 'order' => null + 'order' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'name' => false, - 'order' => false + 'order' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'order' => 'order' + 'order' => 'order', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'order' => 'setOrder' + 'order' => 'setOrder', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'order' => 'getOrder' + 'order' => 'getOrder', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('order', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateResponseSignerRole { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateResponseSignerRole { /** @var TemplateResponseSignerRole */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateResponseSignerRole::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -299,9 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -315,7 +302,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -329,14 +315,14 @@ public function getName() /** * Sets name * - * @param string|null $name The name of the Role. + * @param string|null $name the name of the Role * * @return self */ - public function setName($name) + public function setName(?string $name) { if (is_null($name)) { - throw new \InvalidArgumentException('non-nullable name cannot be null'); + throw new InvalidArgumentException('non-nullable name cannot be null'); } $this->container['name'] = $name; @@ -356,27 +342,26 @@ public function getOrder() /** * Sets order * - * @param int|null $order If signer order is assigned this is the 0-based index for this role. + * @param int|null $order if signer order is assigned this is the 0-based index for this role * * @return self */ - public function setOrder($order) + public function setOrder(?int $order) { if (is_null($order)) { - throw new \InvalidArgumentException('non-nullable order cannot be null'); + throw new InvalidArgumentException('non-nullable order cannot be null'); } $this->container['order'] = $order; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -385,11 +370,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -400,10 +385,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -416,11 +399,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -428,15 +409,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -462,5 +443,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateUpdateFilesRequest.php b/sdks/php/src/Model/TemplateUpdateFilesRequest.php index 8ff73ccc5..7c165ff7d 100644 --- a/sdks/php/src/Model/TemplateUpdateFilesRequest.php +++ b/sdks/php/src/Model/TemplateUpdateFilesRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,78 +27,80 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * TemplateUpdateFilesRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateUpdateFilesRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateUpdateFilesRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateUpdateFilesRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'files' => '\SplFileObject[]', 'file_urls' => 'string[]', 'message' => 'string', 'subject' => 'string', - 'test_mode' => 'bool' + 'test_mode' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'files' => 'binary', 'file_urls' => null, 'message' => null, 'subject' => null, - 'test_mode' => null + 'test_mode' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'files' => false, 'file_urls' => false, 'message' => false, 'subject' => false, - 'test_mode' => false + 'test_mode' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -125,8 +125,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -136,7 +134,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -146,7 +144,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -155,9 +153,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -166,9 +161,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -187,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'file_urls', 'message' => 'message', 'subject' => 'subject', - 'test_mode' => 'test_mode' + 'test_mode' => 'test_mode', ]; /** @@ -201,7 +193,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'setFileUrls', 'message' => 'setMessage', 'subject' => 'setSubject', - 'test_mode' => 'setTestMode' + 'test_mode' => 'setTestMode', ]; /** @@ -215,7 +207,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'getFileUrls', 'message' => 'getMessage', 'subject' => 'getSubject', - 'test_mode' => 'getTestMode' + 'test_mode' => 'getTestMode', ]; /** @@ -259,7 +251,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -283,34 +274,33 @@ public function __construct(array $data = null) $this->setIfExists('test_mode', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateUpdateFilesRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateUpdateFilesRequest { /** @var TemplateUpdateFilesRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateUpdateFilesRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -351,7 +341,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets client_id * @@ -365,14 +354,14 @@ public function getClientId() /** * Sets client_id * - * @param string|null $client_id Client id of the app you're using to update this template. + * @param string|null $client_id client id of the app you're using to update this template * * @return self */ - public function setClientId($client_id) + public function setClientId(?string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -382,7 +371,7 @@ public function setClientId($client_id) /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -392,14 +381,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to use for the template. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to use for the template. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -423,10 +412,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -446,17 +435,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The new default template email message. + * @param string|null $message the new default template email message * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling TemplateUpdateFilesRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling TemplateUpdateFilesRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -477,17 +466,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The new default template email subject. + * @param string|null $subject the new default template email subject * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 100)) { - throw new \InvalidArgumentException('invalid length for $subject when calling TemplateUpdateFilesRequest., must be smaller than or equal to 100.'); + if (mb_strlen($subject) > 100) { + throw new InvalidArgumentException('invalid length for $subject when calling TemplateUpdateFilesRequest., must be smaller than or equal to 100.'); } $this->container['subject'] = $subject; @@ -512,23 +501,22 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -537,11 +525,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -552,10 +540,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -568,11 +554,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -580,15 +564,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -614,5 +598,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateUpdateFilesResponse.php b/sdks/php/src/Model/TemplateUpdateFilesResponse.php index 98dd2ae54..d8080fb74 100644 --- a/sdks/php/src/Model/TemplateUpdateFilesResponse.php +++ b/sdks/php/src/Model/TemplateUpdateFilesResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,63 +27,64 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateUpdateFilesResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateUpdateFilesResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateUpdateFilesResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateUpdateFilesResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ - 'template' => '\Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate' + 'template' => '\Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ - 'template' => null + 'template' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ - 'template' => false + 'template' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -110,8 +109,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -121,7 +118,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -131,7 +128,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -140,9 +137,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -151,9 +145,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -167,7 +158,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'template' => 'template' + 'template' => 'template', ]; /** @@ -176,7 +167,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'template' => 'setTemplate' + 'template' => 'setTemplate', ]; /** @@ -185,7 +176,7 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'template' => 'getTemplate' + 'template' => 'getTemplate', ]; /** @@ -229,7 +220,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -248,34 +238,33 @@ public function __construct(array $data = null) $this->setIfExists('template', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateUpdateFilesResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateUpdateFilesResponse { /** @var TemplateUpdateFilesResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateUpdateFilesResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -311,11 +300,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template * - * @return \Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate + * @return TemplateUpdateFilesResponseTemplate */ public function getTemplate() { @@ -325,27 +313,26 @@ public function getTemplate() /** * Sets template * - * @param \Dropbox\Sign\Model\TemplateUpdateFilesResponseTemplate $template template + * @param TemplateUpdateFilesResponseTemplate $template template * * @return self */ - public function setTemplate($template) + public function setTemplate(TemplateUpdateFilesResponseTemplate $template) { if (is_null($template)) { - throw new \InvalidArgumentException('non-nullable template cannot be null'); + throw new InvalidArgumentException('non-nullable template cannot be null'); } $this->container['template'] = $template; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -354,11 +341,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -369,10 +356,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -385,11 +370,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -397,15 +380,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -431,5 +414,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php index e3b123e5b..70d2e87dc 100644 --- a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php +++ b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,67 +27,68 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * TemplateUpdateFilesResponseTemplate Class Doc Comment * * @category Class * @description Contains template id - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class TemplateUpdateFilesResponseTemplate implements ModelInterface, ArrayAccess, \JsonSerializable +class TemplateUpdateFilesResponseTemplate implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'TemplateUpdateFilesResponseTemplate'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'template_id' => 'string', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'template_id' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'template_id' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -172,7 +163,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'template_id' => 'template_id', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'template_id' => 'setTemplateId', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'template_id' => 'getTemplateId', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -236,7 +227,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -256,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): TemplateUpdateFilesResponseTemplate { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): TemplateUpdateFilesResponseTemplate { /** @var TemplateUpdateFilesResponseTemplate */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, TemplateUpdateFilesResponseTemplate::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -300,9 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -316,7 +303,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets template_id * @@ -330,14 +316,14 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id The id of the Template. + * @param string|null $template_id the id of the Template * * @return self */ - public function setTemplateId($template_id) + public function setTemplateId(?string $template_id) { if (is_null($template_id)) { - throw new \InvalidArgumentException('non-nullable template_id cannot be null'); + throw new InvalidArgumentException('non-nullable template_id cannot be null'); } $this->container['template_id'] = $template_id; @@ -347,7 +333,7 @@ public function setTemplateId($template_id) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null * @deprecated */ public function getWarnings() @@ -358,28 +344,27 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self * @deprecated */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +373,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +388,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +402,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +412,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +446,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php index 658bed2c0..8d4a7e3e2 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,37 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * UnclaimedDraftCreateEmbeddedRequest Class Doc Comment * * @category Class - * @description - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @description + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftCreateEmbeddedRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'requester_email_address' => 'string', @@ -94,16 +94,16 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'use_preexisting_fields' => 'bool', 'use_text_tags' => 'bool', 'populate_auto_fill_fields' => 'bool', - 'expires_at' => 'int' + 'expires_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'requester_email_address' => 'email', @@ -140,14 +140,14 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'use_preexisting_fields' => null, 'use_text_tags' => null, 'populate_auto_fill_fields' => null, - 'expires_at' => null + 'expires_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'requester_email_address' => false, @@ -184,14 +184,14 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'use_preexisting_fields' => false, 'use_text_tags' => false, 'populate_auto_fill_fields' => false, - 'expires_at' => true + 'expires_at' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -216,8 +216,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -227,7 +225,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -237,7 +235,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -246,9 +244,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -257,9 +252,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -308,7 +300,7 @@ public function isNullableSetToNull(string $property): bool 'use_preexisting_fields' => 'use_preexisting_fields', 'use_text_tags' => 'use_text_tags', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', - 'expires_at' => 'expires_at' + 'expires_at' => 'expires_at', ]; /** @@ -352,7 +344,7 @@ public function isNullableSetToNull(string $property): bool 'use_preexisting_fields' => 'setUsePreexistingFields', 'use_text_tags' => 'setUseTextTags', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', - 'expires_at' => 'setExpiresAt' + 'expires_at' => 'setExpiresAt', ]; /** @@ -396,7 +388,7 @@ public function isNullableSetToNull(string $property): bool 'use_preexisting_fields' => 'getUsePreexistingFields', 'use_text_tags' => 'getUseTextTags', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', - 'expires_at' => 'getExpiresAt' + 'expires_at' => 'getExpiresAt', ]; /** @@ -509,34 +501,33 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): UnclaimedDraftCreateEmbeddedRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): UnclaimedDraftCreateEmbeddedRequest { /** @var UnclaimedDraftCreateEmbeddedRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, UnclaimedDraftCreateEmbeddedRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -592,7 +583,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets client_id * @@ -610,10 +600,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -633,14 +623,14 @@ public function getRequesterEmailAddress() /** * Sets requester_email_address * - * @param string $requester_email_address The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. + * @param string $requester_email_address the email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature` * * @return self */ - public function setRequesterEmailAddress($requester_email_address) + public function setRequesterEmailAddress(string $requester_email_address) { if (is_null($requester_email_address)) { - throw new \InvalidArgumentException('non-nullable requester_email_address cannot be null'); + throw new InvalidArgumentException('non-nullable requester_email_address cannot be null'); } $this->container['requester_email_address'] = $requester_email_address; @@ -650,7 +640,7 @@ public function setRequesterEmailAddress($requester_email_address) /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -660,14 +650,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -691,10 +681,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -714,14 +704,14 @@ public function getAllowCcs() /** * Sets allow_ccs * - * @param bool|null $allow_ccs This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. + * @param bool|null $allow_ccs this allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft * * @return self */ - public function setAllowCcs($allow_ccs) + public function setAllowCcs(?bool $allow_ccs) { if (is_null($allow_ccs)) { - throw new \InvalidArgumentException('non-nullable allow_ccs cannot be null'); + throw new InvalidArgumentException('non-nullable allow_ccs cannot be null'); } $this->container['allow_ccs'] = $allow_ccs; @@ -745,10 +735,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline($allow_decline) + public function setAllowDecline(?bool $allow_decline) { if (is_null($allow_decline)) { - throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -772,10 +762,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign($allow_reassign) + public function setAllowReassign(?bool $allow_reassign) { if (is_null($allow_reassign)) { - throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -785,7 +775,7 @@ public function setAllowReassign($allow_reassign) /** * Gets attachments * - * @return \Dropbox\Sign\Model\SubAttachment[]|null + * @return SubAttachment[]|null */ public function getAttachments() { @@ -795,14 +785,14 @@ public function getAttachments() /** * Sets attachments * - * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments($attachments) + public function setAttachments(?array $attachments) { if (is_null($attachments)) { - throw new \InvalidArgumentException('non-nullable attachments cannot be null'); + throw new InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -822,14 +812,14 @@ public function getCcEmailAddresses() /** * Sets cc_email_addresses * - * @param string[]|null $cc_email_addresses The email addresses that should be CCed. + * @param string[]|null $cc_email_addresses the email addresses that should be CCed * * @return self */ - public function setCcEmailAddresses($cc_email_addresses) + public function setCcEmailAddresses(?array $cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -839,7 +829,7 @@ public function setCcEmailAddresses($cc_email_addresses) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SubCustomField[]|null + * @return SubCustomField[]|null */ public function getCustomFields() { @@ -849,14 +839,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -866,7 +856,7 @@ public function setCustomFields($custom_fields) /** * Gets editor_options * - * @return \Dropbox\Sign\Model\SubEditorOptions|null + * @return SubEditorOptions|null */ public function getEditorOptions() { @@ -876,14 +866,14 @@ public function getEditorOptions() /** * Sets editor_options * - * @param \Dropbox\Sign\Model\SubEditorOptions|null $editor_options editor_options + * @param SubEditorOptions|null $editor_options editor_options * * @return self */ - public function setEditorOptions($editor_options) + public function setEditorOptions(?SubEditorOptions $editor_options) { if (is_null($editor_options)) { - throw new \InvalidArgumentException('non-nullable editor_options cannot be null'); + throw new InvalidArgumentException('non-nullable editor_options cannot be null'); } $this->container['editor_options'] = $editor_options; @@ -893,7 +883,7 @@ public function setEditorOptions($editor_options) /** * Gets field_options * - * @return \Dropbox\Sign\Model\SubFieldOptions|null + * @return SubFieldOptions|null */ public function getFieldOptions() { @@ -903,14 +893,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options + * @param SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions($field_options) + public function setFieldOptions(?SubFieldOptions $field_options) { if (is_null($field_options)) { - throw new \InvalidArgumentException('non-nullable field_options cannot be null'); + throw new InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -930,14 +920,14 @@ public function getForceSignerPage() /** * Sets force_signer_page * - * @param bool|null $force_signer_page Provide users the ability to review/edit the signers. + * @param bool|null $force_signer_page provide users the ability to review/edit the signers * * @return self */ - public function setForceSignerPage($force_signer_page) + public function setForceSignerPage(?bool $force_signer_page) { if (is_null($force_signer_page)) { - throw new \InvalidArgumentException('non-nullable force_signer_page cannot be null'); + throw new InvalidArgumentException('non-nullable force_signer_page cannot be null'); } $this->container['force_signer_page'] = $force_signer_page; @@ -957,14 +947,14 @@ public function getForceSubjectMessage() /** * Sets force_subject_message * - * @param bool|null $force_subject_message Provide users the ability to review/edit the subject and message. + * @param bool|null $force_subject_message provide users the ability to review/edit the subject and message * * @return self */ - public function setForceSubjectMessage($force_subject_message) + public function setForceSubjectMessage(?bool $force_subject_message) { if (is_null($force_subject_message)) { - throw new \InvalidArgumentException('non-nullable force_subject_message cannot be null'); + throw new InvalidArgumentException('non-nullable force_subject_message cannot be null'); } $this->container['force_subject_message'] = $force_subject_message; @@ -974,7 +964,7 @@ public function setForceSubjectMessage($force_subject_message) /** * Gets form_field_groups * - * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null + * @return SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -984,14 +974,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups($form_field_groups) + public function setFormFieldGroups(?array $form_field_groups) { if (is_null($form_field_groups)) { - throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -1001,7 +991,7 @@ public function setFormFieldGroups($form_field_groups) /** * Gets form_field_rules * - * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null + * @return SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -1011,14 +1001,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. + * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` * * @return self */ - public function setFormFieldRules($form_field_rules) + public function setFormFieldRules(?array $form_field_rules) { if (is_null($form_field_rules)) { - throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -1028,7 +1018,7 @@ public function setFormFieldRules($form_field_rules) /** * Gets form_fields_per_document * - * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null + * @return SubFormFieldsPerDocumentBase[]|null */ public function getFormFieldsPerDocument() { @@ -1038,14 +1028,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument($form_fields_per_document) + public function setFormFieldsPerDocument(?array $form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -1069,10 +1059,10 @@ public function getHideTextTags() * * @return self */ - public function setHideTextTags($hide_text_tags) + public function setHideTextTags(?bool $hide_text_tags) { if (is_null($hide_text_tags)) { - throw new \InvalidArgumentException('non-nullable hide_text_tags cannot be null'); + throw new InvalidArgumentException('non-nullable hide_text_tags cannot be null'); } $this->container['hide_text_tags'] = $hide_text_tags; @@ -1096,10 +1086,10 @@ public function getHoldRequest() * * @return self */ - public function setHoldRequest($hold_request) + public function setHoldRequest(?bool $hold_request) { if (is_null($hold_request)) { - throw new \InvalidArgumentException('non-nullable hold_request cannot be null'); + throw new InvalidArgumentException('non-nullable hold_request cannot be null'); } $this->container['hold_request'] = $hold_request; @@ -1123,10 +1113,10 @@ public function getIsForEmbeddedSigning() * * @return self */ - public function setIsForEmbeddedSigning($is_for_embedded_signing) + public function setIsForEmbeddedSigning(?bool $is_for_embedded_signing) { if (is_null($is_for_embedded_signing)) { - throw new \InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); + throw new InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); } $this->container['is_for_embedded_signing'] = $is_for_embedded_signing; @@ -1146,17 +1136,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that will be sent to the signers. + * @param string|null $message the custom message in the email that will be sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateEmbeddedRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateEmbeddedRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -1181,13 +1171,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -1206,14 +1195,14 @@ public function getRequestingRedirectUrl() /** * Sets requesting_redirect_url * - * @param string|null $requesting_redirect_url The URL you want signers redirected to after they successfully request a signature. + * @param string|null $requesting_redirect_url the URL you want signers redirected to after they successfully request a signature * * @return self */ - public function setRequestingRedirectUrl($requesting_redirect_url) + public function setRequestingRedirectUrl(?string $requesting_redirect_url) { if (is_null($requesting_redirect_url)) { - throw new \InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); } $this->container['requesting_redirect_url'] = $requesting_redirect_url; @@ -1237,10 +1226,10 @@ public function getShowPreview() * * @return self */ - public function setShowPreview($show_preview) + public function setShowPreview(?bool $show_preview) { if (is_null($show_preview)) { - throw new \InvalidArgumentException('non-nullable show_preview cannot be null'); + throw new InvalidArgumentException('non-nullable show_preview cannot be null'); } $this->container['show_preview'] = $show_preview; @@ -1260,14 +1249,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden * * @return self */ - public function setShowProgressStepper($show_progress_stepper) + public function setShowProgressStepper(?bool $show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -1277,7 +1266,7 @@ public function setShowProgressStepper($show_progress_stepper) /** * Gets signers * - * @return \Dropbox\Sign\Model\SubUnclaimedDraftSigner[]|null + * @return SubUnclaimedDraftSigner[]|null */ public function getSigners() { @@ -1287,14 +1276,14 @@ public function getSigners() /** * Sets signers * - * @param \Dropbox\Sign\Model\SubUnclaimedDraftSigner[]|null $signers Add Signers to your Unclaimed Draft Signature Request. + * @param SubUnclaimedDraftSigner[]|null $signers add Signers to your Unclaimed Draft Signature Request * * @return self */ - public function setSigners($signers) + public function setSigners(?array $signers) { if (is_null($signers)) { - throw new \InvalidArgumentException('non-nullable signers cannot be null'); + throw new InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -1304,7 +1293,7 @@ public function setSigners($signers) /** * Gets signing_options * - * @return \Dropbox\Sign\Model\SubSigningOptions|null + * @return SubSigningOptions|null */ public function getSigningOptions() { @@ -1314,14 +1303,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options + * @param SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions($signing_options) + public function setSigningOptions(?SubSigningOptions $signing_options) { if (is_null($signing_options)) { - throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -1341,14 +1330,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -1372,10 +1361,10 @@ public function getSkipMeNow() * * @return self */ - public function setSkipMeNow($skip_me_now) + public function setSkipMeNow(?bool $skip_me_now) { if (is_null($skip_me_now)) { - throw new \InvalidArgumentException('non-nullable skip_me_now cannot be null'); + throw new InvalidArgumentException('non-nullable skip_me_now cannot be null'); } $this->container['skip_me_now'] = $skip_me_now; @@ -1395,17 +1384,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that will be sent to the signers. + * @param string|null $subject the subject in the email that will be sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 200)) { - throw new \InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateEmbeddedRequest., must be smaller than or equal to 200.'); + if (mb_strlen($subject) > 200) { + throw new InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateEmbeddedRequest., must be smaller than or equal to 200.'); } $this->container['subject'] = $subject; @@ -1430,10 +1419,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1457,14 +1446,14 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(?string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'type', must be one of '%s'", $type, @@ -1494,10 +1483,10 @@ public function getUsePreexistingFields() * * @return self */ - public function setUsePreexistingFields($use_preexisting_fields) + public function setUsePreexistingFields(?bool $use_preexisting_fields) { if (is_null($use_preexisting_fields)) { - throw new \InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); + throw new InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); } $this->container['use_preexisting_fields'] = $use_preexisting_fields; @@ -1521,10 +1510,10 @@ public function getUseTextTags() * * @return self */ - public function setUseTextTags($use_text_tags) + public function setUseTextTags(?bool $use_text_tags) { if (is_null($use_text_tags)) { - throw new \InvalidArgumentException('non-nullable use_text_tags cannot be null'); + throw new InvalidArgumentException('non-nullable use_text_tags cannot be null'); } $this->container['use_text_tags'] = $use_text_tags; @@ -1548,10 +1537,10 @@ public function getPopulateAutoFillFields() * * @return self */ - public function setPopulateAutoFillFields($populate_auto_fill_fields) + public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) { if (is_null($populate_auto_fill_fields)) { - throw new \InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); + throw new InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); } $this->container['populate_auto_fill_fields'] = $populate_auto_fill_fields; @@ -1575,14 +1564,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1591,14 +1580,13 @@ public function setExpiresAt($expires_at) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1607,11 +1595,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1622,10 +1610,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1638,11 +1624,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1650,15 +1634,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1684,5 +1668,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php index fdc7ee890..df0b1df69 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,36 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * UnclaimedDraftCreateEmbeddedWithTemplateRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftCreateEmbeddedWithTemplateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'requester_email_address' => 'string', @@ -87,16 +87,16 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface, 'test_mode' => 'bool', 'title' => 'string', 'populate_auto_fill_fields' => 'bool', - 'allow_ccs' => 'bool' + 'allow_ccs' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'requester_email_address' => 'email', @@ -127,14 +127,14 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface, 'test_mode' => null, 'title' => null, 'populate_auto_fill_fields' => null, - 'allow_ccs' => null + 'allow_ccs' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'requester_email_address' => false, @@ -165,14 +165,14 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface, 'test_mode' => false, 'title' => false, 'populate_auto_fill_fields' => false, - 'allow_ccs' => false + 'allow_ccs' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -197,8 +197,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -208,7 +206,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -218,7 +216,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -227,9 +225,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -238,9 +233,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -283,7 +275,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', - 'allow_ccs' => 'allow_ccs' + 'allow_ccs' => 'allow_ccs', ]; /** @@ -321,7 +313,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', - 'allow_ccs' => 'setAllowCcs' + 'allow_ccs' => 'setAllowCcs', ]; /** @@ -359,7 +351,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', - 'allow_ccs' => 'getAllowCcs' + 'allow_ccs' => 'getAllowCcs', ]; /** @@ -403,7 +395,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -451,34 +442,33 @@ public function __construct(array $data = null) $this->setIfExists('allow_ccs', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): UnclaimedDraftCreateEmbeddedWithTemplateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): UnclaimedDraftCreateEmbeddedWithTemplateRequest { /** @var UnclaimedDraftCreateEmbeddedWithTemplateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, UnclaimedDraftCreateEmbeddedWithTemplateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -532,7 +522,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets client_id * @@ -550,10 +539,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -573,14 +562,14 @@ public function getRequesterEmailAddress() /** * Sets requester_email_address * - * @param string $requester_email_address The email address of the user that should be designated as the requester of this draft. + * @param string $requester_email_address the email address of the user that should be designated as the requester of this draft * * @return self */ - public function setRequesterEmailAddress($requester_email_address) + public function setRequesterEmailAddress(string $requester_email_address) { if (is_null($requester_email_address)) { - throw new \InvalidArgumentException('non-nullable requester_email_address cannot be null'); + throw new InvalidArgumentException('non-nullable requester_email_address cannot be null'); } $this->container['requester_email_address'] = $requester_email_address; @@ -600,14 +589,14 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[] $template_ids Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. + * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used * * @return self */ - public function setTemplateIds($template_ids) + public function setTemplateIds(array $template_ids) { if (is_null($template_ids)) { - throw new \InvalidArgumentException('non-nullable template_ids cannot be null'); + throw new InvalidArgumentException('non-nullable template_ids cannot be null'); } $this->container['template_ids'] = $template_ids; @@ -631,10 +620,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline($allow_decline) + public function setAllowDecline(?bool $allow_decline) { if (is_null($allow_decline)) { - throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -658,10 +647,10 @@ public function getAllowReassign() * * @return self */ - public function setAllowReassign($allow_reassign) + public function setAllowReassign(?bool $allow_reassign) { if (is_null($allow_reassign)) { - throw new \InvalidArgumentException('non-nullable allow_reassign cannot be null'); + throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); } $this->container['allow_reassign'] = $allow_reassign; @@ -671,7 +660,7 @@ public function setAllowReassign($allow_reassign) /** * Gets ccs * - * @return \Dropbox\Sign\Model\SubCC[]|null + * @return SubCC[]|null */ public function getCcs() { @@ -681,14 +670,14 @@ public function getCcs() /** * Sets ccs * - * @param \Dropbox\Sign\Model\SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. * * @return self */ - public function setCcs($ccs) + public function setCcs(?array $ccs) { if (is_null($ccs)) { - throw new \InvalidArgumentException('non-nullable ccs cannot be null'); + throw new InvalidArgumentException('non-nullable ccs cannot be null'); } $this->container['ccs'] = $ccs; @@ -698,7 +687,7 @@ public function setCcs($ccs) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SubCustomField[]|null + * @return SubCustomField[]|null */ public function getCustomFields() { @@ -708,14 +697,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. + * @param SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -725,7 +714,7 @@ public function setCustomFields($custom_fields) /** * Gets editor_options * - * @return \Dropbox\Sign\Model\SubEditorOptions|null + * @return SubEditorOptions|null */ public function getEditorOptions() { @@ -735,14 +724,14 @@ public function getEditorOptions() /** * Sets editor_options * - * @param \Dropbox\Sign\Model\SubEditorOptions|null $editor_options editor_options + * @param SubEditorOptions|null $editor_options editor_options * * @return self */ - public function setEditorOptions($editor_options) + public function setEditorOptions(?SubEditorOptions $editor_options) { if (is_null($editor_options)) { - throw new \InvalidArgumentException('non-nullable editor_options cannot be null'); + throw new InvalidArgumentException('non-nullable editor_options cannot be null'); } $this->container['editor_options'] = $editor_options; @@ -752,7 +741,7 @@ public function setEditorOptions($editor_options) /** * Gets field_options * - * @return \Dropbox\Sign\Model\SubFieldOptions|null + * @return SubFieldOptions|null */ public function getFieldOptions() { @@ -762,14 +751,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options + * @param SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions($field_options) + public function setFieldOptions(?SubFieldOptions $field_options) { if (is_null($field_options)) { - throw new \InvalidArgumentException('non-nullable field_options cannot be null'); + throw new InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -779,7 +768,7 @@ public function setFieldOptions($field_options) /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -789,14 +778,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both. + * @param SplFileObject[]|null $files Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both. * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -820,10 +809,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -843,14 +832,14 @@ public function getForceSignerRoles() /** * Sets force_signer_roles * - * @param bool|null $force_signer_roles Provide users the ability to review/edit the template signer roles. + * @param bool|null $force_signer_roles provide users the ability to review/edit the template signer roles * * @return self */ - public function setForceSignerRoles($force_signer_roles) + public function setForceSignerRoles(?bool $force_signer_roles) { if (is_null($force_signer_roles)) { - throw new \InvalidArgumentException('non-nullable force_signer_roles cannot be null'); + throw new InvalidArgumentException('non-nullable force_signer_roles cannot be null'); } $this->container['force_signer_roles'] = $force_signer_roles; @@ -870,14 +859,14 @@ public function getForceSubjectMessage() /** * Sets force_subject_message * - * @param bool|null $force_subject_message Provide users the ability to review/edit the template subject and message. + * @param bool|null $force_subject_message provide users the ability to review/edit the template subject and message * * @return self */ - public function setForceSubjectMessage($force_subject_message) + public function setForceSubjectMessage(?bool $force_subject_message) { if (is_null($force_subject_message)) { - throw new \InvalidArgumentException('non-nullable force_subject_message cannot be null'); + throw new InvalidArgumentException('non-nullable force_subject_message cannot be null'); } $this->container['force_subject_message'] = $force_subject_message; @@ -901,10 +890,10 @@ public function getHoldRequest() * * @return self */ - public function setHoldRequest($hold_request) + public function setHoldRequest(?bool $hold_request) { if (is_null($hold_request)) { - throw new \InvalidArgumentException('non-nullable hold_request cannot be null'); + throw new InvalidArgumentException('non-nullable hold_request cannot be null'); } $this->container['hold_request'] = $hold_request; @@ -928,10 +917,10 @@ public function getIsForEmbeddedSigning() * * @return self */ - public function setIsForEmbeddedSigning($is_for_embedded_signing) + public function setIsForEmbeddedSigning(?bool $is_for_embedded_signing) { if (is_null($is_for_embedded_signing)) { - throw new \InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); + throw new InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); } $this->container['is_for_embedded_signing'] = $is_for_embedded_signing; @@ -951,17 +940,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that will be sent to the signers. + * @param string|null $message the custom message in the email that will be sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -986,13 +975,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -1015,10 +1003,10 @@ public function getPreviewOnly() * * @return self */ - public function setPreviewOnly($preview_only) + public function setPreviewOnly(?bool $preview_only) { if (is_null($preview_only)) { - throw new \InvalidArgumentException('non-nullable preview_only cannot be null'); + throw new InvalidArgumentException('non-nullable preview_only cannot be null'); } $this->container['preview_only'] = $preview_only; @@ -1038,14 +1026,14 @@ public function getRequestingRedirectUrl() /** * Sets requesting_redirect_url * - * @param string|null $requesting_redirect_url The URL you want signers redirected to after they successfully request a signature. + * @param string|null $requesting_redirect_url the URL you want signers redirected to after they successfully request a signature * * @return self */ - public function setRequestingRedirectUrl($requesting_redirect_url) + public function setRequestingRedirectUrl(?string $requesting_redirect_url) { if (is_null($requesting_redirect_url)) { - throw new \InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); } $this->container['requesting_redirect_url'] = $requesting_redirect_url; @@ -1069,10 +1057,10 @@ public function getShowPreview() * * @return self */ - public function setShowPreview($show_preview) + public function setShowPreview(?bool $show_preview) { if (is_null($show_preview)) { - throw new \InvalidArgumentException('non-nullable show_preview cannot be null'); + throw new InvalidArgumentException('non-nullable show_preview cannot be null'); } $this->container['show_preview'] = $show_preview; @@ -1092,14 +1080,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden * * @return self */ - public function setShowProgressStepper($show_progress_stepper) + public function setShowProgressStepper(?bool $show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -1109,7 +1097,7 @@ public function setShowProgressStepper($show_progress_stepper) /** * Gets signers * - * @return \Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner[]|null + * @return SubUnclaimedDraftTemplateSigner[]|null */ public function getSigners() { @@ -1119,14 +1107,14 @@ public function getSigners() /** * Sets signers * - * @param \Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner[]|null $signers Add Signers to your Templated-based Signature Request. + * @param SubUnclaimedDraftTemplateSigner[]|null $signers add Signers to your Templated-based Signature Request * * @return self */ - public function setSigners($signers) + public function setSigners(?array $signers) { if (is_null($signers)) { - throw new \InvalidArgumentException('non-nullable signers cannot be null'); + throw new InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -1136,7 +1124,7 @@ public function setSigners($signers) /** * Gets signing_options * - * @return \Dropbox\Sign\Model\SubSigningOptions|null + * @return SubSigningOptions|null */ public function getSigningOptions() { @@ -1146,14 +1134,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options + * @param SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions($signing_options) + public function setSigningOptions(?SubSigningOptions $signing_options) { if (is_null($signing_options)) { - throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -1173,14 +1161,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -1204,10 +1192,10 @@ public function getSkipMeNow() * * @return self */ - public function setSkipMeNow($skip_me_now) + public function setSkipMeNow(?bool $skip_me_now) { if (is_null($skip_me_now)) { - throw new \InvalidArgumentException('non-nullable skip_me_now cannot be null'); + throw new InvalidArgumentException('non-nullable skip_me_now cannot be null'); } $this->container['skip_me_now'] = $skip_me_now; @@ -1227,17 +1215,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that will be sent to the signers. + * @param string|null $subject the subject in the email that will be sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 255)) { - throw new \InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['subject'] = $subject; @@ -1262,10 +1250,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1285,17 +1273,17 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title you want to assign to the SignatureRequest. + * @param string|null $title the title you want to assign to the SignatureRequest * * @return self */ - public function setTitle($title) + public function setTitle(?string $title) { if (is_null($title)) { - throw new \InvalidArgumentException('non-nullable title cannot be null'); + throw new InvalidArgumentException('non-nullable title cannot be null'); } - if ((mb_strlen($title) > 255)) { - throw new \InvalidArgumentException('invalid length for $title when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling UnclaimedDraftCreateEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); } $this->container['title'] = $title; @@ -1320,10 +1308,10 @@ public function getPopulateAutoFillFields() * * @return self */ - public function setPopulateAutoFillFields($populate_auto_fill_fields) + public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) { if (is_null($populate_auto_fill_fields)) { - throw new \InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); + throw new InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); } $this->container['populate_auto_fill_fields'] = $populate_auto_fill_fields; @@ -1343,27 +1331,26 @@ public function getAllowCcs() /** * Sets allow_ccs * - * @param bool|null $allow_ccs This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. + * @param bool|null $allow_ccs this allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft * * @return self */ - public function setAllowCcs($allow_ccs) + public function setAllowCcs(?bool $allow_ccs) { if (is_null($allow_ccs)) { - throw new \InvalidArgumentException('non-nullable allow_ccs cannot be null'); + throw new InvalidArgumentException('non-nullable allow_ccs cannot be null'); } $this->container['allow_ccs'] = $allow_ccs; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1372,11 +1359,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1387,10 +1374,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1403,11 +1388,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1415,15 +1398,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1449,5 +1432,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php index 7cc9353d8..1d55c2c1b 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,35 +27,37 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; +use SplFileObject; /** * UnclaimedDraftCreateRequest Class Doc Comment * * @category Class - * @description - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @description + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftCreateRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'type' => 'string', 'files' => '\SplFileObject[]', @@ -82,16 +82,16 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, \JsonS 'test_mode' => 'bool', 'use_preexisting_fields' => 'bool', 'use_text_tags' => 'bool', - 'expires_at' => 'int' + 'expires_at' => 'int', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'type' => null, 'files' => 'binary', @@ -116,14 +116,14 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, \JsonS 'test_mode' => null, 'use_preexisting_fields' => null, 'use_text_tags' => null, - 'expires_at' => null + 'expires_at' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'type' => false, 'files' => false, @@ -148,14 +148,14 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, \JsonS 'test_mode' => false, 'use_preexisting_fields' => false, 'use_text_tags' => false, - 'expires_at' => true + 'expires_at' => true, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -180,8 +180,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -191,7 +189,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -201,7 +199,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -210,9 +208,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -221,9 +216,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -260,7 +252,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'use_preexisting_fields' => 'use_preexisting_fields', 'use_text_tags' => 'use_text_tags', - 'expires_at' => 'expires_at' + 'expires_at' => 'expires_at', ]; /** @@ -292,7 +284,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'use_preexisting_fields' => 'setUsePreexistingFields', 'use_text_tags' => 'setUseTextTags', - 'expires_at' => 'setExpiresAt' + 'expires_at' => 'setExpiresAt', ]; /** @@ -324,7 +316,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'use_preexisting_fields' => 'getUsePreexistingFields', 'use_text_tags' => 'getUseTextTags', - 'expires_at' => 'getExpiresAt' + 'expires_at' => 'getExpiresAt', ]; /** @@ -425,34 +417,33 @@ public function __construct(array $data = null) $this->setIfExists('expires_at', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): UnclaimedDraftCreateRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): UnclaimedDraftCreateRequest { /** @var UnclaimedDraftCreateRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, UnclaimedDraftCreateRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -505,7 +496,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -523,14 +513,14 @@ public function getType() * * @return self */ - public function setType($type) + public function setType(string $type) { if (is_null($type)) { - throw new \InvalidArgumentException('non-nullable type cannot be null'); + throw new InvalidArgumentException('non-nullable type cannot be null'); } $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { - throw new \InvalidArgumentException( + throw new InvalidArgumentException( sprintf( "Invalid value '%s' for 'type', must be one of '%s'", $type, @@ -546,7 +536,7 @@ public function setType($type) /** * Gets files * - * @return \SplFileObject[]|null + * @return SplFileObject[]|null */ public function getFiles() { @@ -556,14 +546,14 @@ public function getFiles() /** * Sets files * - * @param \SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. * * @return self */ - public function setFiles($files) + public function setFiles(?array $files) { if (is_null($files)) { - throw new \InvalidArgumentException('non-nullable files cannot be null'); + throw new InvalidArgumentException('non-nullable files cannot be null'); } $this->container['files'] = $files; @@ -587,10 +577,10 @@ public function getFileUrls() * * @return self */ - public function setFileUrls($file_urls) + public function setFileUrls(?array $file_urls) { if (is_null($file_urls)) { - throw new \InvalidArgumentException('non-nullable file_urls cannot be null'); + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); } $this->container['file_urls'] = $file_urls; @@ -614,10 +604,10 @@ public function getAllowDecline() * * @return self */ - public function setAllowDecline($allow_decline) + public function setAllowDecline(?bool $allow_decline) { if (is_null($allow_decline)) { - throw new \InvalidArgumentException('non-nullable allow_decline cannot be null'); + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); } $this->container['allow_decline'] = $allow_decline; @@ -627,7 +617,7 @@ public function setAllowDecline($allow_decline) /** * Gets attachments * - * @return \Dropbox\Sign\Model\SubAttachment[]|null + * @return SubAttachment[]|null */ public function getAttachments() { @@ -637,14 +627,14 @@ public function getAttachments() /** * Sets attachments * - * @param \Dropbox\Sign\Model\SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments A list describing the attachments * * @return self */ - public function setAttachments($attachments) + public function setAttachments(?array $attachments) { if (is_null($attachments)) { - throw new \InvalidArgumentException('non-nullable attachments cannot be null'); + throw new InvalidArgumentException('non-nullable attachments cannot be null'); } $this->container['attachments'] = $attachments; @@ -664,14 +654,14 @@ public function getCcEmailAddresses() /** * Sets cc_email_addresses * - * @param string[]|null $cc_email_addresses The email addresses that should be CCed. + * @param string[]|null $cc_email_addresses the email addresses that should be CCed * * @return self */ - public function setCcEmailAddresses($cc_email_addresses) + public function setCcEmailAddresses(?array $cc_email_addresses) { if (is_null($cc_email_addresses)) { - throw new \InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); } $this->container['cc_email_addresses'] = $cc_email_addresses; @@ -695,10 +685,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(?string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -708,7 +698,7 @@ public function setClientId($client_id) /** * Gets custom_fields * - * @return \Dropbox\Sign\Model\SubCustomField[]|null + * @return SubCustomField[]|null */ public function getCustomFields() { @@ -718,14 +708,14 @@ public function getCustomFields() /** * Sets custom_fields * - * @param \Dropbox\Sign\Model\SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. * * @return self */ - public function setCustomFields($custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { - throw new \InvalidArgumentException('non-nullable custom_fields cannot be null'); + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); } $this->container['custom_fields'] = $custom_fields; @@ -735,7 +725,7 @@ public function setCustomFields($custom_fields) /** * Gets field_options * - * @return \Dropbox\Sign\Model\SubFieldOptions|null + * @return SubFieldOptions|null */ public function getFieldOptions() { @@ -745,14 +735,14 @@ public function getFieldOptions() /** * Sets field_options * - * @param \Dropbox\Sign\Model\SubFieldOptions|null $field_options field_options + * @param SubFieldOptions|null $field_options field_options * * @return self */ - public function setFieldOptions($field_options) + public function setFieldOptions(?SubFieldOptions $field_options) { if (is_null($field_options)) { - throw new \InvalidArgumentException('non-nullable field_options cannot be null'); + throw new InvalidArgumentException('non-nullable field_options cannot be null'); } $this->container['field_options'] = $field_options; @@ -762,7 +752,7 @@ public function setFieldOptions($field_options) /** * Gets form_field_groups * - * @return \Dropbox\Sign\Model\SubFormFieldGroup[]|null + * @return SubFormFieldGroup[]|null */ public function getFormFieldGroups() { @@ -772,14 +762,14 @@ public function getFormFieldGroups() /** * Sets form_field_groups * - * @param \Dropbox\Sign\Model\SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. * * @return self */ - public function setFormFieldGroups($form_field_groups) + public function setFormFieldGroups(?array $form_field_groups) { if (is_null($form_field_groups)) { - throw new \InvalidArgumentException('non-nullable form_field_groups cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); } $this->container['form_field_groups'] = $form_field_groups; @@ -789,7 +779,7 @@ public function setFormFieldGroups($form_field_groups) /** * Gets form_field_rules * - * @return \Dropbox\Sign\Model\SubFormFieldRule[]|null + * @return SubFormFieldRule[]|null */ public function getFormFieldRules() { @@ -799,14 +789,14 @@ public function getFormFieldRules() /** * Sets form_field_rules * - * @param \Dropbox\Sign\Model\SubFormFieldRule[]|null $form_field_rules Conditional Logic rules for fields defined in `form_fields_per_document`. + * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` * * @return self */ - public function setFormFieldRules($form_field_rules) + public function setFormFieldRules(?array $form_field_rules) { if (is_null($form_field_rules)) { - throw new \InvalidArgumentException('non-nullable form_field_rules cannot be null'); + throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); } $this->container['form_field_rules'] = $form_field_rules; @@ -816,7 +806,7 @@ public function setFormFieldRules($form_field_rules) /** * Gets form_fields_per_document * - * @return \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null + * @return SubFormFieldsPerDocumentBase[]|null */ public function getFormFieldsPerDocument() { @@ -826,14 +816,14 @@ public function getFormFieldsPerDocument() /** * Sets form_fields_per_document * - * @param \Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` * * @return self */ - public function setFormFieldsPerDocument($form_fields_per_document) + public function setFormFieldsPerDocument(?array $form_fields_per_document) { if (is_null($form_fields_per_document)) { - throw new \InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); } $this->container['form_fields_per_document'] = $form_fields_per_document; @@ -857,10 +847,10 @@ public function getHideTextTags() * * @return self */ - public function setHideTextTags($hide_text_tags) + public function setHideTextTags(?bool $hide_text_tags) { if (is_null($hide_text_tags)) { - throw new \InvalidArgumentException('non-nullable hide_text_tags cannot be null'); + throw new InvalidArgumentException('non-nullable hide_text_tags cannot be null'); } $this->container['hide_text_tags'] = $hide_text_tags; @@ -880,17 +870,17 @@ public function getMessage() /** * Sets message * - * @param string|null $message The custom message in the email that will be sent to the signers. + * @param string|null $message the custom message in the email that will be sent to the signers * * @return self */ - public function setMessage($message) + public function setMessage(?string $message) { if (is_null($message)) { - throw new \InvalidArgumentException('non-nullable message cannot be null'); + throw new InvalidArgumentException('non-nullable message cannot be null'); } - if ((mb_strlen($message) > 5000)) { - throw new \InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateRequest., must be smaller than or equal to 5000.'); + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling UnclaimedDraftCreateRequest., must be smaller than or equal to 5000.'); } $this->container['message'] = $message; @@ -915,13 +905,12 @@ public function getMetadata() * * @return self */ - public function setMetadata($metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { - throw new \InvalidArgumentException('non-nullable metadata cannot be null'); + throw new InvalidArgumentException('non-nullable metadata cannot be null'); } - $this->container['metadata'] = $metadata; return $this; @@ -940,14 +929,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden * * @return self */ - public function setShowProgressStepper($show_progress_stepper) + public function setShowProgressStepper(?bool $show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -957,7 +946,7 @@ public function setShowProgressStepper($show_progress_stepper) /** * Gets signers * - * @return \Dropbox\Sign\Model\SubUnclaimedDraftSigner[]|null + * @return SubUnclaimedDraftSigner[]|null */ public function getSigners() { @@ -967,14 +956,14 @@ public function getSigners() /** * Sets signers * - * @param \Dropbox\Sign\Model\SubUnclaimedDraftSigner[]|null $signers Add Signers to your Unclaimed Draft Signature Request. + * @param SubUnclaimedDraftSigner[]|null $signers add Signers to your Unclaimed Draft Signature Request * * @return self */ - public function setSigners($signers) + public function setSigners(?array $signers) { if (is_null($signers)) { - throw new \InvalidArgumentException('non-nullable signers cannot be null'); + throw new InvalidArgumentException('non-nullable signers cannot be null'); } $this->container['signers'] = $signers; @@ -984,7 +973,7 @@ public function setSigners($signers) /** * Gets signing_options * - * @return \Dropbox\Sign\Model\SubSigningOptions|null + * @return SubSigningOptions|null */ public function getSigningOptions() { @@ -994,14 +983,14 @@ public function getSigningOptions() /** * Sets signing_options * - * @param \Dropbox\Sign\Model\SubSigningOptions|null $signing_options signing_options + * @param SubSigningOptions|null $signing_options signing_options * * @return self */ - public function setSigningOptions($signing_options) + public function setSigningOptions(?SubSigningOptions $signing_options) { if (is_null($signing_options)) { - throw new \InvalidArgumentException('non-nullable signing_options cannot be null'); + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); } $this->container['signing_options'] = $signing_options; @@ -1021,14 +1010,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -1048,17 +1037,17 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject The subject in the email that will be sent to the signers. + * @param string|null $subject the subject in the email that will be sent to the signers * * @return self */ - public function setSubject($subject) + public function setSubject(?string $subject) { if (is_null($subject)) { - throw new \InvalidArgumentException('non-nullable subject cannot be null'); + throw new InvalidArgumentException('non-nullable subject cannot be null'); } - if ((mb_strlen($subject) > 200)) { - throw new \InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateRequest., must be smaller than or equal to 200.'); + if (mb_strlen($subject) > 200) { + throw new InvalidArgumentException('invalid length for $subject when calling UnclaimedDraftCreateRequest., must be smaller than or equal to 200.'); } $this->container['subject'] = $subject; @@ -1083,10 +1072,10 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; @@ -1110,10 +1099,10 @@ public function getUsePreexistingFields() * * @return self */ - public function setUsePreexistingFields($use_preexisting_fields) + public function setUsePreexistingFields(?bool $use_preexisting_fields) { if (is_null($use_preexisting_fields)) { - throw new \InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); + throw new InvalidArgumentException('non-nullable use_preexisting_fields cannot be null'); } $this->container['use_preexisting_fields'] = $use_preexisting_fields; @@ -1137,10 +1126,10 @@ public function getUseTextTags() * * @return self */ - public function setUseTextTags($use_text_tags) + public function setUseTextTags(?bool $use_text_tags) { if (is_null($use_text_tags)) { - throw new \InvalidArgumentException('non-nullable use_text_tags cannot be null'); + throw new InvalidArgumentException('non-nullable use_text_tags cannot be null'); } $this->container['use_text_tags'] = $use_text_tags; @@ -1164,14 +1153,14 @@ public function getExpiresAt() * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -1180,14 +1169,13 @@ public function setExpiresAt($expires_at) return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -1196,11 +1184,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -1211,10 +1199,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -1227,11 +1213,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -1239,15 +1223,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -1273,5 +1257,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/UnclaimedDraftCreateResponse.php b/sdks/php/src/Model/UnclaimedDraftCreateResponse.php index 4bacee2f5..fb93528ef 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateResponse.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,66 +27,67 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * UnclaimedDraftCreateResponse Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftCreateResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class UnclaimedDraftCreateResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftCreateResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'unclaimed_draft' => '\Dropbox\Sign\Model\UnclaimedDraftResponse', - 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]' + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'unclaimed_draft' => null, - 'warnings' => null + 'warnings' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'unclaimed_draft' => false, - 'warnings' => false + 'warnings' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -113,8 +112,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -124,7 +121,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -134,7 +131,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -143,9 +140,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -154,9 +148,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -171,7 +162,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'unclaimed_draft' => 'unclaimed_draft', - 'warnings' => 'warnings' + 'warnings' => 'warnings', ]; /** @@ -181,7 +172,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'unclaimed_draft' => 'setUnclaimedDraft', - 'warnings' => 'setWarnings' + 'warnings' => 'setWarnings', ]; /** @@ -191,7 +182,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'unclaimed_draft' => 'getUnclaimedDraft', - 'warnings' => 'getWarnings' + 'warnings' => 'getWarnings', ]; /** @@ -235,7 +226,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -255,34 +245,33 @@ public function __construct(array $data = null) $this->setIfExists('warnings', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): UnclaimedDraftCreateResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): UnclaimedDraftCreateResponse { /** @var UnclaimedDraftCreateResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, UnclaimedDraftCreateResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -318,11 +307,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets unclaimed_draft * - * @return \Dropbox\Sign\Model\UnclaimedDraftResponse + * @return UnclaimedDraftResponse */ public function getUnclaimedDraft() { @@ -332,14 +320,14 @@ public function getUnclaimedDraft() /** * Sets unclaimed_draft * - * @param \Dropbox\Sign\Model\UnclaimedDraftResponse $unclaimed_draft unclaimed_draft + * @param UnclaimedDraftResponse $unclaimed_draft unclaimed_draft * * @return self */ - public function setUnclaimedDraft($unclaimed_draft) + public function setUnclaimedDraft(UnclaimedDraftResponse $unclaimed_draft) { if (is_null($unclaimed_draft)) { - throw new \InvalidArgumentException('non-nullable unclaimed_draft cannot be null'); + throw new InvalidArgumentException('non-nullable unclaimed_draft cannot be null'); } $this->container['unclaimed_draft'] = $unclaimed_draft; @@ -349,7 +337,7 @@ public function setUnclaimedDraft($unclaimed_draft) /** * Gets warnings * - * @return \Dropbox\Sign\Model\WarningResponse[]|null + * @return WarningResponse[]|null */ public function getWarnings() { @@ -359,27 +347,26 @@ public function getWarnings() /** * Sets warnings * - * @param \Dropbox\Sign\Model\WarningResponse[]|null $warnings A list of warnings. + * @param WarningResponse[]|null $warnings a list of warnings * * @return self */ - public function setWarnings($warnings) + public function setWarnings(?array $warnings) { if (is_null($warnings)) { - throw new \InvalidArgumentException('non-nullable warnings cannot be null'); + throw new InvalidArgumentException('non-nullable warnings cannot be null'); } $this->container['warnings'] = $warnings; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -388,11 +375,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -403,10 +390,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -419,11 +404,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -431,15 +414,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -465,5 +448,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/UnclaimedDraftEditAndResendRequest.php b/sdks/php/src/Model/UnclaimedDraftEditAndResendRequest.php index 38704f677..5669e4848 100644 --- a/sdks/php/src/Model/UnclaimedDraftEditAndResendRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftEditAndResendRequest.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,34 +27,35 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * UnclaimedDraftEditAndResendRequest Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftEditAndResendRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class UnclaimedDraftEditAndResendRequest implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftEditAndResendRequest'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'client_id' => 'string', 'editor_options' => '\Dropbox\Sign\Model\SubEditorOptions', @@ -65,16 +64,16 @@ class UnclaimedDraftEditAndResendRequest implements ModelInterface, ArrayAccess, 'requesting_redirect_url' => 'string', 'show_progress_stepper' => 'bool', 'signing_redirect_url' => 'string', - 'test_mode' => 'bool' + 'test_mode' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'client_id' => null, 'editor_options' => null, @@ -83,14 +82,14 @@ class UnclaimedDraftEditAndResendRequest implements ModelInterface, ArrayAccess, 'requesting_redirect_url' => null, 'show_progress_stepper' => null, 'signing_redirect_url' => null, - 'test_mode' => null + 'test_mode' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'client_id' => false, 'editor_options' => false, @@ -99,14 +98,14 @@ class UnclaimedDraftEditAndResendRequest implements ModelInterface, ArrayAccess, 'requesting_redirect_url' => false, 'show_progress_stepper' => false, 'signing_redirect_url' => false, - 'test_mode' => false + 'test_mode' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -131,8 +130,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -142,7 +139,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -152,7 +149,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -161,9 +158,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -172,9 +166,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -195,7 +186,7 @@ public function isNullableSetToNull(string $property): bool 'requesting_redirect_url' => 'requesting_redirect_url', 'show_progress_stepper' => 'show_progress_stepper', 'signing_redirect_url' => 'signing_redirect_url', - 'test_mode' => 'test_mode' + 'test_mode' => 'test_mode', ]; /** @@ -211,7 +202,7 @@ public function isNullableSetToNull(string $property): bool 'requesting_redirect_url' => 'setRequestingRedirectUrl', 'show_progress_stepper' => 'setShowProgressStepper', 'signing_redirect_url' => 'setSigningRedirectUrl', - 'test_mode' => 'setTestMode' + 'test_mode' => 'setTestMode', ]; /** @@ -227,7 +218,7 @@ public function isNullableSetToNull(string $property): bool 'requesting_redirect_url' => 'getRequestingRedirectUrl', 'show_progress_stepper' => 'getShowProgressStepper', 'signing_redirect_url' => 'getSigningRedirectUrl', - 'test_mode' => 'getTestMode' + 'test_mode' => 'getTestMode', ]; /** @@ -271,7 +262,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -297,34 +287,33 @@ public function __construct(array $data = null) $this->setIfExists('test_mode', $data ?? [], false); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): UnclaimedDraftEditAndResendRequest { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): UnclaimedDraftEditAndResendRequest { /** @var UnclaimedDraftEditAndResendRequest */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, UnclaimedDraftEditAndResendRequest::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -360,7 +349,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets client_id * @@ -378,10 +366,10 @@ public function getClientId() * * @return self */ - public function setClientId($client_id) + public function setClientId(string $client_id) { if (is_null($client_id)) { - throw new \InvalidArgumentException('non-nullable client_id cannot be null'); + throw new InvalidArgumentException('non-nullable client_id cannot be null'); } $this->container['client_id'] = $client_id; @@ -391,7 +379,7 @@ public function setClientId($client_id) /** * Gets editor_options * - * @return \Dropbox\Sign\Model\SubEditorOptions|null + * @return SubEditorOptions|null */ public function getEditorOptions() { @@ -401,14 +389,14 @@ public function getEditorOptions() /** * Sets editor_options * - * @param \Dropbox\Sign\Model\SubEditorOptions|null $editor_options editor_options + * @param SubEditorOptions|null $editor_options editor_options * * @return self */ - public function setEditorOptions($editor_options) + public function setEditorOptions(?SubEditorOptions $editor_options) { if (is_null($editor_options)) { - throw new \InvalidArgumentException('non-nullable editor_options cannot be null'); + throw new InvalidArgumentException('non-nullable editor_options cannot be null'); } $this->container['editor_options'] = $editor_options; @@ -428,14 +416,14 @@ public function getIsForEmbeddedSigning() /** * Sets is_for_embedded_signing * - * @param bool|null $is_for_embedded_signing The request created from this draft will also be signable in embedded mode if set to `true`. + * @param bool|null $is_for_embedded_signing the request created from this draft will also be signable in embedded mode if set to `true` * * @return self */ - public function setIsForEmbeddedSigning($is_for_embedded_signing) + public function setIsForEmbeddedSigning(?bool $is_for_embedded_signing) { if (is_null($is_for_embedded_signing)) { - throw new \InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); + throw new InvalidArgumentException('non-nullable is_for_embedded_signing cannot be null'); } $this->container['is_for_embedded_signing'] = $is_for_embedded_signing; @@ -459,10 +447,10 @@ public function getRequesterEmailAddress() * * @return self */ - public function setRequesterEmailAddress($requester_email_address) + public function setRequesterEmailAddress(?string $requester_email_address) { if (is_null($requester_email_address)) { - throw new \InvalidArgumentException('non-nullable requester_email_address cannot be null'); + throw new InvalidArgumentException('non-nullable requester_email_address cannot be null'); } $this->container['requester_email_address'] = $requester_email_address; @@ -482,14 +470,14 @@ public function getRequestingRedirectUrl() /** * Sets requesting_redirect_url * - * @param string|null $requesting_redirect_url The URL you want signers redirected to after they successfully request a signature. + * @param string|null $requesting_redirect_url the URL you want signers redirected to after they successfully request a signature * * @return self */ - public function setRequestingRedirectUrl($requesting_redirect_url) + public function setRequestingRedirectUrl(?string $requesting_redirect_url) { if (is_null($requesting_redirect_url)) { - throw new \InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable requesting_redirect_url cannot be null'); } $this->container['requesting_redirect_url'] = $requesting_redirect_url; @@ -509,14 +497,14 @@ public function getShowProgressStepper() /** * Sets show_progress_stepper * - * @param bool|null $show_progress_stepper When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + * @param bool|null $show_progress_stepper when only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden * * @return self */ - public function setShowProgressStepper($show_progress_stepper) + public function setShowProgressStepper(?bool $show_progress_stepper) { if (is_null($show_progress_stepper)) { - throw new \InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); + throw new InvalidArgumentException('non-nullable show_progress_stepper cannot be null'); } $this->container['show_progress_stepper'] = $show_progress_stepper; @@ -536,14 +524,14 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { - throw new \InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); } $this->container['signing_redirect_url'] = $signing_redirect_url; @@ -567,23 +555,22 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -592,11 +579,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -607,10 +594,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -623,11 +608,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -635,15 +618,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -669,5 +652,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/UnclaimedDraftResponse.php b/sdks/php/src/Model/UnclaimedDraftResponse.php index b50d57465..da1c26359 100644 --- a/sdks/php/src/Model/UnclaimedDraftResponse.php +++ b/sdks/php/src/Model/UnclaimedDraftResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,79 +27,80 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * UnclaimedDraftResponse Class Doc Comment * * @category Class * @description A group of documents that a user can take ownership of via the claim URL. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class UnclaimedDraftResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class UnclaimedDraftResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'UnclaimedDraftResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'signature_request_id' => 'string', 'claim_url' => 'string', 'signing_redirect_url' => 'string', 'requesting_redirect_url' => 'string', 'expires_at' => 'int', - 'test_mode' => 'bool' + 'test_mode' => 'bool', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'signature_request_id' => null, 'claim_url' => null, 'signing_redirect_url' => null, 'requesting_redirect_url' => null, 'expires_at' => null, - 'test_mode' => null + 'test_mode' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'signature_request_id' => true, 'claim_url' => false, 'signing_redirect_url' => true, 'requesting_redirect_url' => true, 'expires_at' => true, - 'test_mode' => false + 'test_mode' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -126,8 +125,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -137,7 +134,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -147,7 +144,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -156,9 +153,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -167,9 +161,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -188,7 +179,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'signing_redirect_url', 'requesting_redirect_url' => 'requesting_redirect_url', 'expires_at' => 'expires_at', - 'test_mode' => 'test_mode' + 'test_mode' => 'test_mode', ]; /** @@ -202,7 +193,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'setSigningRedirectUrl', 'requesting_redirect_url' => 'setRequestingRedirectUrl', 'expires_at' => 'setExpiresAt', - 'test_mode' => 'setTestMode' + 'test_mode' => 'setTestMode', ]; /** @@ -216,7 +207,7 @@ public function isNullableSetToNull(string $property): bool 'signing_redirect_url' => 'getSigningRedirectUrl', 'requesting_redirect_url' => 'getRequestingRedirectUrl', 'expires_at' => 'getExpiresAt', - 'test_mode' => 'getTestMode' + 'test_mode' => 'getTestMode', ]; /** @@ -260,7 +251,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -284,34 +274,33 @@ public function __construct(array $data = null) $this->setIfExists('test_mode', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): UnclaimedDraftResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): UnclaimedDraftResponse { /** @var UnclaimedDraftResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, UnclaimedDraftResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -328,9 +317,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - return $invalidProperties; + return []; } /** @@ -344,7 +331,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets signature_request_id * @@ -358,18 +344,18 @@ public function getSignatureRequestId() /** * Sets signature_request_id * - * @param string|null $signature_request_id The ID of the signature request that is represented by this UnclaimedDraft. + * @param string|null $signature_request_id the ID of the signature request that is represented by this UnclaimedDraft * * @return self */ - public function setSignatureRequestId($signature_request_id) + public function setSignatureRequestId(?string $signature_request_id) { if (is_null($signature_request_id)) { array_push($this->openAPINullablesSetToNull, 'signature_request_id'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signature_request_id', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -392,14 +378,14 @@ public function getClaimUrl() /** * Sets claim_url * - * @param string|null $claim_url The URL to be used to claim this UnclaimedDraft. + * @param string|null $claim_url the URL to be used to claim this UnclaimedDraft * * @return self */ - public function setClaimUrl($claim_url) + public function setClaimUrl(?string $claim_url) { if (is_null($claim_url)) { - throw new \InvalidArgumentException('non-nullable claim_url cannot be null'); + throw new InvalidArgumentException('non-nullable claim_url cannot be null'); } $this->container['claim_url'] = $claim_url; @@ -419,18 +405,18 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url The URL you want signers redirected to after they successfully sign. + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign * * @return self */ - public function setSigningRedirectUrl($signing_redirect_url) + public function setSigningRedirectUrl(?string $signing_redirect_url) { if (is_null($signing_redirect_url)) { array_push($this->openAPINullablesSetToNull, 'signing_redirect_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('signing_redirect_url', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -457,14 +443,14 @@ public function getRequestingRedirectUrl() * * @return self */ - public function setRequestingRedirectUrl($requesting_redirect_url) + public function setRequestingRedirectUrl(?string $requesting_redirect_url) { if (is_null($requesting_redirect_url)) { array_push($this->openAPINullablesSetToNull, 'requesting_redirect_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('requesting_redirect_url', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -487,18 +473,18 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at When the link expires. + * @param int|null $expires_at when the link expires * * @return self */ - public function setExpiresAt($expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { array_push($this->openAPINullablesSetToNull, 'expires_at'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); $index = array_search('expires_at', $nullablesSetToNull); - if ($index !== FALSE) { + if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } @@ -525,23 +511,22 @@ public function getTestMode() * * @return self */ - public function setTestMode($test_mode) + public function setTestMode(?bool $test_mode) { if (is_null($test_mode)) { - throw new \InvalidArgumentException('non-nullable test_mode cannot be null'); + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); } $this->container['test_mode'] = $test_mode; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -550,11 +535,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -565,10 +550,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -581,11 +564,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -593,15 +574,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -627,5 +608,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/Model/WarningResponse.php b/sdks/php/src/Model/WarningResponse.php index f8b97f736..4c37010a0 100644 --- a/sdks/php/src/Model/WarningResponse.php +++ b/sdks/php/src/Model/WarningResponse.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,67 +27,68 @@ namespace Dropbox\Sign\Model; -use \ArrayAccess; -use \Dropbox\Sign\ObjectSerializer; +use ArrayAccess; +use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; +use JsonSerializable; +use ReturnTypeWillChange; /** * WarningResponse Class Doc Comment * * @category Class * @description A list of warnings. - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech * @implements \ArrayAccess */ -class WarningResponse implements ModelInterface, ArrayAccess, \JsonSerializable +class WarningResponse implements ModelInterface, ArrayAccess, JsonSerializable { public const DISCRIMINATOR = null; /** - * The original name of the model. - * - * @var string - */ + * The original name of the model. + * + * @var string + */ protected static $openAPIModelName = 'WarningResponse'; /** - * Array of property to type mappings. Used for (de)serialization - * - * @var string[] - */ + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ protected static $openAPITypes = [ 'warning_msg' => 'string', - 'warning_name' => 'string' + 'warning_name' => 'string', ]; /** - * Array of property to format mappings. Used for (de)serialization - * - * @var string[] - * @phpstan-var array - * @psalm-var array - */ + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ protected static $openAPIFormats = [ 'warning_msg' => null, - 'warning_name' => null + 'warning_name' => null, ]; /** - * Array of nullable properties. Used for (de)serialization - * - * @var boolean[] - */ + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ protected static array $openAPINullables = [ 'warning_msg' => false, - 'warning_name' => false + 'warning_name' => false, ]; /** - * If a nullable field gets set to null, insert it here - * - * @var boolean[] - */ + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ protected array $openAPINullablesSetToNull = []; /** @@ -114,8 +113,6 @@ public static function openAPIFormats() /** * Array of nullable properties - * - * @return array */ protected static function openAPINullables(): array { @@ -125,7 +122,7 @@ protected static function openAPINullables(): array /** * Array of nullable field names deliberately set to null * - * @return boolean[] + * @return bool[] */ private function getOpenAPINullablesSetToNull(): array { @@ -135,7 +132,7 @@ private function getOpenAPINullablesSetToNull(): array /** * Setter - Array of nullable field names deliberately set to null * - * @param boolean[] $openAPINullablesSetToNull + * @param bool[] $openAPINullablesSetToNull */ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void { @@ -144,9 +141,6 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): /** * Checks if a property is nullable - * - * @param string $property - * @return bool */ public static function isNullable(string $property): bool { @@ -155,9 +149,6 @@ public static function isNullable(string $property): bool /** * Checks if a nullable property is set to null. - * - * @param string $property - * @return bool */ public function isNullableSetToNull(string $property): bool { @@ -172,7 +163,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'warning_msg' => 'warning_msg', - 'warning_name' => 'warning_name' + 'warning_name' => 'warning_name', ]; /** @@ -182,7 +173,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'warning_msg' => 'setWarningMsg', - 'warning_name' => 'setWarningName' + 'warning_name' => 'setWarningName', ]; /** @@ -192,7 +183,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'warning_msg' => 'getWarningMsg', - 'warning_name' => 'getWarningName' + 'warning_name' => 'getWarningName', ]; /** @@ -236,7 +227,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -256,34 +246,33 @@ public function __construct(array $data = null) $this->setIfExists('warning_name', $data ?? [], null); } - /** @deprecated use ::init() */ + /** + * @deprecated use ::init() + */ public static function fromArray(array $data): WarningResponse { return self::init($data); } - /** Attempt to instantiate and hydrate a new instance of this class */ + /** + * Attempt to instantiate and hydrate a new instance of this class + */ public static function init(array $data): WarningResponse { /** @var WarningResponse */ - $obj = ObjectSerializer::deserialize( + return ObjectSerializer::deserialize( $data, WarningResponse::class, ); - - return $obj; } - /** - * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName - * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the - * $this->openAPINullablesSetToNull array - * - * @param string $variableName - * @param array $fields -* @param string|int|object|array|mixed $defaultValue - */ + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ private function setIfExists(string $variableName, array $fields, $defaultValue): void { if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { @@ -322,7 +311,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets warning_msg * @@ -340,10 +328,10 @@ public function getWarningMsg() * * @return self */ - public function setWarningMsg($warning_msg) + public function setWarningMsg(string $warning_msg) { if (is_null($warning_msg)) { - throw new \InvalidArgumentException('non-nullable warning_msg cannot be null'); + throw new InvalidArgumentException('non-nullable warning_msg cannot be null'); } $this->container['warning_msg'] = $warning_msg; @@ -367,23 +355,22 @@ public function getWarningName() * * @return self */ - public function setWarningName($warning_name) + public function setWarningName(string $warning_name) { if (is_null($warning_name)) { - throw new \InvalidArgumentException('non-nullable warning_name cannot be null'); + throw new InvalidArgumentException('non-nullable warning_name cannot be null'); } $this->container['warning_name'] = $warning_name; return $this; } + /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset - * - * @return boolean + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetExists($offset): bool { return isset($this->container[$offset]); @@ -392,11 +379,11 @@ public function offsetExists($offset): bool /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetGet($offset) { return $this->container[$offset] ?? null; @@ -407,10 +394,8 @@ public function offsetGet($offset) * * @param int|null $offset Offset * @param mixed $value Value to be set - * - * @return void */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetSet($offset, $value): void { if (is_null($offset)) { @@ -423,11 +408,9 @@ public function offsetSet($offset, $value): void /** * Unsets offset. * - * @param integer $offset Offset - * - * @return void + * @param int $offset Offset */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function offsetUnset($offset): void { unset($this->container[$offset]); @@ -435,15 +418,15 @@ public function offsetUnset($offset): void /** * Serializes the object to a value that can be serialized natively by json_encode(). - * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ - #[\ReturnTypeWillChange] + #[ReturnTypeWillChange] public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** @@ -469,5 +452,3 @@ public function toHeaderValue() return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - - diff --git a/sdks/php/src/ObjectSerializer.php b/sdks/php/src/ObjectSerializer.php index 25c1ba9ff..958cd8e04 100644 --- a/sdks/php/src/ObjectSerializer.php +++ b/sdks/php/src/ObjectSerializer.php @@ -5,9 +5,7 @@ * PHP version 7.4 * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ /** @@ -29,29 +27,31 @@ namespace Dropbox\Sign; -use GuzzleHttp\Psr7\Utils; +use DateTime; use Dropbox\Sign\Model\ModelInterface; +use Exception; use GuzzleHttp; +use GuzzleHttp\Psr7\Utils; +use InvalidArgumentException; +use SplFileObject; /** * ObjectSerializer Class Doc Comment * * @category Class - * @package Dropbox\Sign - * @author OpenAPI Generator team - * @link https://openapi-generator.tech + * @see https://openapi-generator.tech */ class ObjectSerializer { /** @var string */ - private static $dateTimeFormat = \DateTime::ATOM; + private static $dateTimeFormat = DateTime::ATOM; /** * Change the date format * - * @param string $format the new date format to use + * @param string $format the new date format to use */ - public static function setDateTimeFormat($format) + public static function setDateTimeFormat(string $format) { self::$dateTimeFormat = $format; } @@ -59,19 +59,19 @@ public static function setDateTimeFormat($format) /** * Serialize data * - * @param string|int|object|array|mixed $data the data to serialize - * @param string $type the OpenAPIToolsType of the data - * @param string $format the format of the OpenAPITools type of the data + * @param string|int|object|array|mixed $data the data to serialize + * @param string $type the OpenAPIToolsType of the data + * @param string $format the format of the OpenAPITools type of the data * * @return scalar|object|array|null serialized form of $data */ - public static function sanitizeForSerialization($data, $type = null, $format = null) + public static function sanitizeForSerialization($data, string $type = null, string $format = null) { if (is_scalar($data) || null === $data) { return $data; } - if ($data instanceof \DateTime) { + if ($data instanceof DateTime) { return ($format === 'date') ? $data->format('Y-m-d') : $data->format(self::$dateTimeFormat); } @@ -88,7 +88,7 @@ public static function sanitizeForSerialization($data, $type = null, $format = n $formats = $data::openAPIFormats(); foreach ($data::openAPITypes() as $property => $openAPIType) { $getter = $data::getters()[$property]; - $value = $data->$getter(); + $value = $data->{$getter}(); if ($value !== null && !in_array($openAPIType, ['\DateTime', '\SplFileObject', 'array', 'bool', 'boolean', 'byte', 'float', 'int', 'integer', 'mixed', 'number', 'object', 'string', 'void'], true)) { $callable = [$openAPIType, 'getAllowableEnumValues']; if (is_callable($callable)) { @@ -96,7 +96,7 @@ public static function sanitizeForSerialization($data, $type = null, $format = n $allowedEnumTypes = $callable(); if (!in_array($value, $allowedEnumTypes, true)) { $imploded = implode("', '", $allowedEnumTypes); - throw new \InvalidArgumentException("Invalid value for enum '$openAPIType', must be one of: '$imploded'"); + throw new InvalidArgumentException("Invalid value for enum '{$openAPIType}', must be one of: '{$imploded}'"); } } } @@ -104,17 +104,16 @@ public static function sanitizeForSerialization($data, $type = null, $format = n $values[$data::attributeMap()[$property]] = self::sanitizeForSerialization($value, $openAPIType, $formats[$property]); } } - } else if ($data instanceof \SplFileObject) { - return (string) $data; + } elseif ($data instanceof SplFileObject) { + return (string)$data; } else { - foreach($data as $property => $value) { + foreach ($data as $property => $value) { $values[$property] = self::sanitizeForSerialization($value); } } return (object)$values; - } else { - return (string)$data; } + return (string)$data; } /** @@ -125,13 +124,12 @@ public static function sanitizeForSerialization($data, $type = null, $format = n * * @return string the sanitized filename */ - public static function sanitizeFilename($filename) + public static function sanitizeFilename(string $filename) { - if (preg_match("/.*[\/\\\\](.*)$/", $filename, $match)) { + if (preg_match('/.*[\\/\\\\](.*)$/', $filename, $match)) { return $match[1]; - } else { - return $filename; } + return $filename; } /** @@ -141,9 +139,11 @@ public static function sanitizeFilename($filename) * * @return string the shorten timestamp */ - public static function sanitizeTimestamp($timestamp) + public static function sanitizeTimestamp(string $timestamp) { - if (!is_string($timestamp)) return $timestamp; + if (!is_string($timestamp)) { + return $timestamp; + } return preg_replace('/(:\d{2}.\d{6})\d*/', '$1', $timestamp); } @@ -156,7 +156,7 @@ public static function sanitizeTimestamp($timestamp) * * @return string the serialized object */ - public static function toPathValue($value) + public static function toPathValue(string $value) { return rawurlencode(self::toString($value)); } @@ -164,27 +164,26 @@ public static function toPathValue($value) /** * Checks if a value is empty, based on its OpenAPI type. * - * @param string|int|object|array|mixed $value - * @param string $openApiType + * @param string|int|object|array|mixed $value * * @return bool true if $value is empty */ private static function isEmptyValue($value, string $openApiType): bool { - # If empty() returns false, it is not empty regardless of its type. + // If empty() returns false, it is not empty regardless of its type. if (!empty($value)) { return false; } - # Null is always empty, as we cannot send a real "null" value in a query parameter. + // Null is always empty, as we cannot send a real "null" value in a query parameter. if ($value === null) { return true; } switch ($openApiType) { - # For numeric values, false and '' are considered empty. - # This comparison is safe for floating point values, since the previous call to empty() will - # filter out values that don't match 0. + // For numeric values, false and '' are considered empty. + // This comparison is safe for floating point values, since the previous call to empty() will + // filter out values that don't match 0. case 'int': case 'integer': return $value !== 0; @@ -193,12 +192,12 @@ private static function isEmptyValue($value, string $openApiType): bool case 'float': return $value !== 0 && $value !== 0.0; - # For boolean values, '' is considered empty + // For boolean values, '' is considered empty case 'bool': case 'boolean': return !in_array($value, [false, 0], true); - # For all the other types, any value at this point can be considered empty. + // For all the other types, any value at this point can be considered empty. default: return true; } @@ -208,14 +207,12 @@ private static function isEmptyValue($value, string $openApiType): bool * Take query parameter properties and turn it into an array suitable for * native http_build_query or GuzzleHttp\Psr7\Query::build. * - * @param string|int|object|array|mixed $value Parameter value - * @param string $paramName Parameter name - * @param string $openApiType OpenAPIType eg. array or object - * @param string $style Parameter serialization style - * @param bool $explode Parameter explode option - * @param bool $required Whether query param is required or not - * - * @return array + * @param string|int|object|array|mixed $value Parameter value + * @param string $paramName Parameter name + * @param string $openApiType OpenAPIType eg. array or object + * @param string $style Parameter serialization style + * @param bool $explode Parameter explode option + * @param bool $required Whether query param is required or not */ public static function toQueryValue( $value, @@ -225,21 +222,19 @@ public static function toQueryValue( bool $explode = true, bool $required = true ): array { - - # Check if we should omit this parameter from the query. This should only happen when: - # - Parameter is NOT required; AND - # - its value is set to a value that is equivalent to "empty", depending on its OpenAPI type. For - # example, 0 as "int" or "boolean" is NOT an empty value. + // Check if we should omit this parameter from the query. This should only happen when: + // - Parameter is NOT required; AND + // - its value is set to a value that is equivalent to "empty", depending on its OpenAPI type. For + // example, 0 as "int" or "boolean" is NOT an empty value. if (self::isEmptyValue($value, $openApiType)) { if ($required) { return ["{$paramName}" => '']; - } else { - return []; } + return []; } - # Handle DateTime objects in query - if($openApiType === "\\DateTime" && $value instanceof \DateTime) { + // Handle DateTime objects in query + if ($openApiType === '\\DateTime' && $value instanceof DateTime) { return ["{$paramName}" => $value->format(self::$dateTimeFormat)]; } @@ -249,7 +244,9 @@ public static function toQueryValue( // since \GuzzleHttp\Psr7\Query::build fails with nested arrays // need to flatten array first $flattenArray = function ($arr, $name, &$result = []) use (&$flattenArray, $style, $explode) { - if (!is_array($arr)) return $arr; + if (!is_array($arr)) { + return $arr; + } foreach ($arr as $k => $v) { $prop = ($style === 'deepObject') ? $prop = "{$name}[{$k}]" : $k; @@ -301,7 +298,7 @@ public static function convertBoolToQueryStringFormat(bool $value) return $value ? 'true' : 'false'; } - return (int) $value; + return (int)$value; } /** @@ -313,7 +310,7 @@ public static function convertBoolToQueryStringFormat(bool $value) * * @return string the header string */ - public static function toHeaderValue($value) + public static function toHeaderValue(string $value) { $callable = [$value, 'toHeaderValue']; if (is_callable($callable)) { @@ -328,17 +325,16 @@ public static function toHeaderValue($value) * the http body (form parameter). If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 * - * @param string|\SplFileObject $value the value of the form parameter + * @param string|SplFileObject $value the value of the form parameter * * @return string the form string */ public static function toFormValue($value) { - if ($value instanceof \SplFileObject) { + if ($value instanceof SplFileObject) { return $value->getRealPath(); - } else { - return self::toString($value); } + return self::toString($value); } /** @@ -353,13 +349,13 @@ public static function toFormValue($value) */ public static function toString($value) { - if ($value instanceof \DateTime) { // datetime in ISO8601 format + if ($value instanceof DateTime) { // datetime in ISO8601 format return $value->format(self::$dateTimeFormat); - } elseif (is_bool($value)) { + } + if (is_bool($value)) { return $value ? 'true' : 'false'; - } else { - return (string) $value; } + return (string)$value; } /** @@ -367,12 +363,12 @@ public static function toString($value) * * @param array $collection collection to serialize to a string * @param string $style the format use for serialization (csv, - * ssv, tsv, pipes, multi) + * ssv, tsv, pipes, multi) * @param bool $allowCollectionFormatMulti allow collection format to be a multidimensional array * * @return string */ - public static function serializeCollection(array $collection, $style, $allowCollectionFormatMulti = false) + public static function serializeCollection(array $collection, string $style, bool $allowCollectionFormatMulti = false) { if ($allowCollectionFormatMulti && ('multi' === $style)) { // http_build_query() almost does the job for us. We just @@ -402,13 +398,13 @@ public static function serializeCollection(array $collection, $style, $allowColl /** * Deserialize a JSON string into an object * - * @param string|int|object|array|mixed $data object or primitive to be deserialized - * @param string $class class name is passed as a string - * @param string[] $httpHeaders HTTP headers + * @param string|int|object|array|mixed $data object or primitive to be deserialized + * @param string $class class name is passed as a string + * @param string[] $httpHeaders HTTP headers * * @return object|array|null a single or an array of $class instances */ - public static function deserialize($data, $class, $httpHeaders = null) + public static function deserialize($data, string $class, array $httpHeaders = null) { if (null === $data) { return null; @@ -418,7 +414,7 @@ public static function deserialize($data, $class, $httpHeaders = null) $data = is_string($data) ? json_decode($data) : $data; if (!is_array($data)) { - throw new \InvalidArgumentException("Invalid array '$class'"); + throw new InvalidArgumentException("Invalid array '{$class}'"); } $subClass = substr($class, 0, -2); @@ -434,7 +430,7 @@ public static function deserialize($data, $class, $httpHeaders = null) settype($data, 'array'); $inner = substr($class, 4, -1); $deserialized = []; - if (strrpos($inner, ",") !== false) { + if (strrpos($inner, ',') !== false) { $subClass_array = explode(',', $inner, 2); $subClass = $subClass_array[1]; foreach ($data as $key => $value) { @@ -447,7 +443,8 @@ public static function deserialize($data, $class, $httpHeaders = null) if ($class === 'object') { settype($data, 'array'); return $data; - } elseif ($class === 'mixed') { + } + if ($class === 'mixed') { settype($data, gettype($data)); return $data; } @@ -461,12 +458,12 @@ public static function deserialize($data, $class, $httpHeaders = null) // this graceful. if (!empty($data)) { try { - return new \DateTime($data); - } catch (\Exception $exception) { + return new DateTime($data); + } catch (Exception $exception) { // Some APIs return a date-time with too high nanosecond // precision for php's DateTime to handle. // With provided regexp 6 digits of microseconds saved - return new \DateTime(self::sanitizeTimestamp($data)); + return new DateTime(self::sanitizeTimestamp($data)); } } else { return null; @@ -474,7 +471,7 @@ public static function deserialize($data, $class, $httpHeaders = null) } if ($class === '\SplFileObject') { - if (is_a($data, \SplFileObject::class)) { + if (is_a($data, SplFileObject::class)) { return $data; } @@ -499,7 +496,7 @@ public static function deserialize($data, $class, $httpHeaders = null) } fclose($file); - return new \SplFileObject($filename, 'r'); + return new SplFileObject($filename, 'r'); } /** @psalm-suppress ParadoxicalCondition */ @@ -508,97 +505,95 @@ public static function deserialize($data, $class, $httpHeaders = null) return $data; } - if (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'"); + throw new InvalidArgumentException("Invalid value for enum '{$class}', must be one of: '{$imploded}'"); } return $data; - } else { - $data = is_string($data) ? json_decode($data) : $data; + } + $data = is_string($data) ? json_decode($data) : $data; - if (is_array($data)) { - $data = (object)$data; - } + if (is_array($data)) { + $data = (object)$data; + } + + // If a discriminator is defined and points to a valid subclass, use it. + $discriminator = $class::DISCRIMINATOR; + $discriminatorValue = null; + if (is_object($data)) { + $discriminatorValue = $data->{$discriminator} ?? null; + } elseif (is_array($data)) { + $discriminatorValue = $data[$discriminator] ?? null; + } - // If a discriminator is defined and points to a valid subclass, use it. - $discriminator = $class::DISCRIMINATOR; - $discriminatorValue = null; - if (is_object($data)) { - $discriminatorValue = $data->{$discriminator} ?? null; - } elseif (is_array($data)) { - $discriminatorValue = $data[$discriminator] ?? null; + $discrimnatorSubclassFound = false; + if (!empty($discriminator) && isset($data->{$discriminator}) && is_string($data->{$discriminator})) { + $subclass = '\Dropbox\Sign\Model\\' . $data->{$discriminator}; + if (is_subclass_of($subclass, $class)) { + $class = $subclass; + $discrimnatorSubclassFound = true; } + } - $discrimnatorSubclassFound = false; - if (!empty($discriminator) && isset($data->{$discriminator}) && is_string($data->{$discriminator})) { - $subclass = '\Dropbox\Sign\Model\\' . $data->{$discriminator}; - if (is_subclass_of($subclass, $class)) { - $class = $subclass; - $discrimnatorSubclassFound = true; - } + if ( + !$discrimnatorSubclassFound + && !empty($discriminator) + && method_exists($class, 'discriminatorClassName') + ) { + $subclass = call_user_func( + "{$class}::discriminatorClassName", + (array)$data, + ); + + if (empty($subclass)) { + return null; } - if ( - !$discrimnatorSubclassFound - && !empty($discriminator) - && method_exists($class, 'discriminatorClassName') - ) { - $subclass = call_user_func( - "{$class}::discriminatorClassName", - (array) $data, - ); + $class = $subclass; + $discrimnatorSubclassFound = true; + } - if (empty($subclass)) { - return null; - } + /** @var ModelInterface $instance */ + $instance = new $class(); + foreach ($instance::openAPITypes() as $property => $type) { + $propertySetter = $instance::setters()[$property]; - $class = $subclass; - $discrimnatorSubclassFound = true; + if (!isset($propertySetter)) { + continue; } - /** @var ModelInterface $instance */ - $instance = new $class(); - foreach ($instance::openAPITypes() as $property => $type) { - $propertySetter = $instance::setters()[$property]; - - if (!isset($propertySetter)) { - continue; + if (!isset($data->{$instance::attributeMap()[$property]})) { + if ($instance::isNullable($property)) { + $instance->{$propertySetter}(null); } - if (!isset($data->{$instance::attributeMap()[$property]})) { - if ($instance::isNullable($property)) { - $instance->$propertySetter(null); - } - - continue; - } + continue; + } - if (isset($data->{$instance::attributeMap()[$property]})) { - $propertyValue = $data->{$instance::attributeMap()[$property]}; - $instance->$propertySetter(self::deserialize($propertyValue, $type, null)); - } + if (isset($data->{$instance::attributeMap()[$property]})) { + $propertyValue = $data->{$instance::attributeMap()[$property]}; + $instance->{$propertySetter}(self::deserialize($propertyValue, $type, null)); } - return $instance; } + return $instance; } /** - * Build a query string from an array of key value pairs. - * - * This function can use the return value of `parse()` to build a query - * string. This function does not modify the provided keys when an array is - * encountered (like `http_build_query()` would). - * - * The function is copied from https://github.com/guzzle/psr7/blob/a243f80a1ca7fe8ceed4deee17f12c1930efe662/src/Query.php#L59-L112 - * with a modification which is described in https://github.com/guzzle/psr7/pull/603 - * - * @param array $params Query string parameters. - * @param int|false $encoding Set to false to not encode, PHP_QUERY_RFC3986 - * to encode using RFC3986, or PHP_QUERY_RFC1738 - * to encode using RFC1738. - */ + * Build a query string from an array of key value pairs. + * + * This function can use the return value of `parse()` to build a query + * string. This function does not modify the provided keys when an array is + * encountered (like `http_build_query()` would). + * + * The function is copied from https://github.com/guzzle/psr7/blob/a243f80a1ca7fe8ceed4deee17f12c1930efe662/src/Query.php#L59-L112 + * with a modification which is described in https://github.com/guzzle/psr7/pull/603 + * + * @param array $params query string parameters + * @param int|false $encoding set to false to not encode, PHP_QUERY_RFC3986 + * to encode using RFC3986, or PHP_QUERY_RFC1738 + * to encode using RFC1738 + */ public static function buildQuery(array $params, $encoding = PHP_QUERY_RFC3986): string { if (!$params) { @@ -614,21 +609,21 @@ public static function buildQuery(array $params, $encoding = PHP_QUERY_RFC3986): } elseif ($encoding === PHP_QUERY_RFC1738) { $encoder = 'urlencode'; } else { - throw new \InvalidArgumentException('Invalid type'); + throw new InvalidArgumentException('Invalid type'); } $castBool = Configuration::BOOLEAN_FORMAT_INT == Configuration::getDefaultConfiguration()->getBooleanFormatForQueryString() - ? function ($v) { return (int) $v; } - : function ($v) { return $v ? 'true' : 'false'; }; + ? function ($v) { return (int)$v; } + : function ($v) { return $v ? 'true' : 'false'; }; $qs = ''; foreach ($params as $k => $v) { - $k = $encoder((string) $k); + $k = $encoder((string)$k); if (!is_array($v)) { $qs .= $k; $v = is_bool($v) ? $castBool($v) : $v; if ($v !== null) { - $qs .= '='.$encoder((string) $v); + $qs .= '=' . $encoder((string)$v); } $qs .= '&'; } else { @@ -636,14 +631,14 @@ public static function buildQuery(array $params, $encoding = PHP_QUERY_RFC3986): $qs .= $k; $vv = is_bool($vv) ? $castBool($vv) : $vv; if ($vv !== null) { - $qs .= '='.$encoder((string) $vv); + $qs .= '=' . $encoder((string)$vv); } $qs .= '&'; } } } - return $qs ? (string) substr($qs, 0, -1) : ''; + return $qs ? (string)substr($qs, 0, -1) : ''; } /** diff --git a/sdks/python/docs/FaxApi.md b/sdks/python/docs/FaxApi.md index 93ec15305..44b5a5c87 100644 --- a/sdks/python/docs/FaxApi.md +++ b/sdks/python/docs/FaxApi.md @@ -16,7 +16,7 @@ Method | HTTP request | Description Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -75,7 +75,7 @@ void (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -137,7 +137,7 @@ with ApiClient(configuration) as api_client: Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -199,7 +199,7 @@ with ApiClient(configuration) as api_client: Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -236,8 +236,8 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `page` | **int** | Page | [optional][default to 1] | -| `page_size` | **int** | Page size | [optional][default to 20] | +| `page` | **int** | Which page number of the Fax List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **int** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | ### Return type @@ -266,7 +266,7 @@ with ApiClient(configuration) as api_client: Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/python/docs/FaxLineAddUserRequest.md b/sdks/python/docs/FaxLineAddUserRequest.md index 9d2c5e199..ddc1053ff 100644 --- a/sdks/python/docs/FaxLineAddUserRequest.md +++ b/sdks/python/docs/FaxLineAddUserRequest.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | +| `number`*_required_ | ```str``` | The Fax Line number | | | `account_id` | ```str``` | Account ID | | | `email_address` | ```str``` | Email address | | diff --git a/sdks/python/docs/FaxLineApi.md b/sdks/python/docs/FaxLineApi.md index 0846b3384..288342e81 100644 --- a/sdks/python/docs/FaxLineApi.md +++ b/sdks/python/docs/FaxLineApi.md @@ -83,7 +83,7 @@ with ApiClient(configuration) as api_client: Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -114,10 +114,10 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `country` | **str** | Filter area codes by country. | | -| `state` | **str** | Filter area codes by state. | [optional] | -| `province` | **str** | Filter area codes by province. | [optional] | -| `city` | **str** | Filter area codes by city. | [optional] | +| `country` | **str** | Filter area codes by country | | +| `state` | **str** | Filter area codes by state | [optional] | +| `province` | **str** | Filter area codes by province | [optional] | +| `city` | **str** | Filter area codes by city | [optional] | ### Return type @@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client: Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -305,7 +305,7 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number` | **str** | The Fax Line number. | | +| `number` | **str** | The Fax Line number | | ### Return type @@ -366,9 +366,9 @@ with ApiClient(configuration) as api_client: | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **str** | Account ID | [optional] | -| `page` | **int** | Page | [optional][default to 1] | -| `page_size` | **int** | Page size | [optional][default to 20] | -| `show_team_lines` | **bool** | Show team lines | [optional] | +| `page` | **int** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **int** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | +| `show_team_lines` | **bool** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -397,7 +397,7 @@ with ApiClient(configuration) as api_client: Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/python/docs/FaxLineCreateRequest.md b/sdks/python/docs/FaxLineCreateRequest.md index b6b33b3ac..0f53c117c 100644 --- a/sdks/python/docs/FaxLineCreateRequest.md +++ b/sdks/python/docs/FaxLineCreateRequest.md @@ -5,10 +5,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `area_code`*_required_ | ```int``` | Area code | | -| `country`*_required_ | ```str``` | Country | | -| `city` | ```str``` | City | | -| `account_id` | ```str``` | Account ID | | +| `area_code`*_required_ | ```int``` | Area code of the new Fax Line | | +| `country`*_required_ | ```str``` | Country of the area code | | +| `city` | ```str``` | City of the area code | | +| `account_id` | ```str``` | Account ID of the account that will be assigned this new Fax Line | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/FaxLineDeleteRequest.md b/sdks/python/docs/FaxLineDeleteRequest.md index ad6985a8e..ad8c4dfe6 100644 --- a/sdks/python/docs/FaxLineDeleteRequest.md +++ b/sdks/python/docs/FaxLineDeleteRequest.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | +| `number`*_required_ | ```str``` | The Fax Line number | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/FaxLineRemoveUserRequest.md b/sdks/python/docs/FaxLineRemoveUserRequest.md index 561ddea6d..e2813a0ed 100644 --- a/sdks/python/docs/FaxLineRemoveUserRequest.md +++ b/sdks/python/docs/FaxLineRemoveUserRequest.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | -| `account_id` | ```str``` | Account ID | | -| `email_address` | ```str``` | Email address | | +| `number`*_required_ | ```str``` | The Fax Line number | | +| `account_id` | ```str``` | Account ID of the user to remove access | | +| `email_address` | ```str``` | Email address of the user to remove access | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/FaxSendRequest.md b/sdks/python/docs/FaxSendRequest.md index cdb4f49a0..50bed5b61 100644 --- a/sdks/python/docs/FaxSendRequest.md +++ b/sdks/python/docs/FaxSendRequest.md @@ -5,13 +5,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```str``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```str``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```str``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List[io.IOBase]``` | Fax File to Send | | -| `file_urls` | ```List[str]``` | Fax File URL to Send | | +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `test_mode` | ```bool``` | API Test Mode Setting | [default to False] | -| `cover_page_to` | ```str``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```str``` | Fax Cover Page for Sender | | +| `cover_page_to` | ```str``` | Fax cover page recipient information | | +| `cover_page_from` | ```str``` | Fax cover page sender information | | | `cover_page_message` | ```str``` | Fax Cover Page Message | | | `title` | ```str``` | Fax Title | | diff --git a/sdks/python/dropbox_sign/__init__.py b/sdks/python/dropbox_sign/__init__.py index 53deb8f21..2192ae233 100644 --- a/sdks/python/dropbox_sign/__init__.py +++ b/sdks/python/dropbox_sign/__init__.py @@ -3,15 +3,15 @@ # flake8: noqa """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/api/account_api.py b/sdks/python/dropbox_sign/api/account_api.py index e3ba0b042..b3e5ce952 100644 --- a/sdks/python/dropbox_sign/api/account_api.py +++ b/sdks/python/dropbox_sign/api/account_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/api_app_api.py b/sdks/python/dropbox_sign/api/api_app_api.py index b130ad383..93752b164 100644 --- a/sdks/python/dropbox_sign/api/api_app_api.py +++ b/sdks/python/dropbox_sign/api/api_app_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/bulk_send_job_api.py b/sdks/python/dropbox_sign/api/bulk_send_job_api.py index 71ee4ca1f..e53401b86 100644 --- a/sdks/python/dropbox_sign/api/bulk_send_job_api.py +++ b/sdks/python/dropbox_sign/api/bulk_send_job_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/embedded_api.py b/sdks/python/dropbox_sign/api/embedded_api.py index 240da1b8e..fcb839f34 100644 --- a/sdks/python/dropbox_sign/api/embedded_api.py +++ b/sdks/python/dropbox_sign/api/embedded_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/fax_api.py b/sdks/python/dropbox_sign/api/fax_api.py index 7d286fc97..1d198e3a0 100644 --- a/sdks/python/dropbox_sign/api/fax_api.py +++ b/sdks/python/dropbox_sign/api/fax_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings @@ -60,7 +60,7 @@ def fax_delete( ) -> None: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -125,7 +125,7 @@ def fax_delete_with_http_info( ) -> ApiResponse[None]: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -190,7 +190,7 @@ def fax_delete_without_preload_content( ) -> RESTResponseType: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -303,7 +303,7 @@ def fax_files( ) -> io.IOBase: """Download Fax Files - Downloads fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -368,7 +368,7 @@ def fax_files_with_http_info( ) -> ApiResponse[io.IOBase]: """Download Fax Files - Downloads fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -433,7 +433,7 @@ def fax_files_without_preload_content( ) -> RESTResponseType: """Download Fax Files - Downloads fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -546,7 +546,7 @@ def fax_get( ) -> FaxGetResponse: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -611,7 +611,7 @@ def fax_get_with_http_info( ) -> ApiResponse[FaxGetResponse]: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -676,7 +676,7 @@ def fax_get_without_preload_content( ) -> RESTResponseType: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -776,11 +776,15 @@ def fax_list( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -796,11 +800,11 @@ def fax_list( ) -> FaxListResponse: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -851,11 +855,15 @@ def fax_list_with_http_info( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -871,11 +879,11 @@ def fax_list_with_http_info( ) -> ApiResponse[FaxListResponse]: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -926,11 +934,15 @@ def fax_list_without_preload_content( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -946,11 +958,11 @@ def fax_list_without_preload_content( ) -> RESTResponseType: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1069,7 +1081,7 @@ def fax_send( ) -> FaxGetResponse: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest @@ -1134,7 +1146,7 @@ def fax_send_with_http_info( ) -> ApiResponse[FaxGetResponse]: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest @@ -1199,7 +1211,7 @@ def fax_send_without_preload_content( ) -> RESTResponseType: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest diff --git a/sdks/python/dropbox_sign/api/fax_line_api.py b/sdks/python/dropbox_sign/api/fax_line_api.py index 50b55d795..24b10831b 100644 --- a/sdks/python/dropbox_sign/api/fax_line_api.py +++ b/sdks/python/dropbox_sign/api/fax_line_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings @@ -327,16 +327,16 @@ def _fax_line_add_user_serialize( def fax_line_area_code_get( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -352,15 +352,15 @@ def fax_line_area_code_get( ) -> FaxLineAreaCodeGetResponse: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/province and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -412,16 +412,16 @@ def fax_line_area_code_get( def fax_line_area_code_get_with_http_info( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -437,15 +437,15 @@ def fax_line_area_code_get_with_http_info( ) -> ApiResponse[FaxLineAreaCodeGetResponse]: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/province and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -497,16 +497,16 @@ def fax_line_area_code_get_with_http_info( def fax_line_area_code_get_without_preload_content( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -522,15 +522,15 @@ def fax_line_area_code_get_without_preload_content( ) -> RESTResponseType: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/province and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -661,7 +661,7 @@ def fax_line_create( ) -> FaxLineResponse: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -726,7 +726,7 @@ def fax_line_create_with_http_info( ) -> ApiResponse[FaxLineResponse]: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -791,7 +791,7 @@ def fax_line_create_without_preload_content( ) -> RESTResponseType: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -1196,7 +1196,7 @@ def _fax_line_delete_serialize( @validate_call def fax_line_get( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1213,7 +1213,7 @@ def fax_line_get( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1261,7 +1261,7 @@ def fax_line_get( @validate_call def fax_line_get_with_http_info( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1278,7 +1278,7 @@ def fax_line_get_with_http_info( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1326,7 +1326,7 @@ def fax_line_get_with_http_info( @validate_call def fax_line_get_without_preload_content( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1343,7 +1343,7 @@ def fax_line_get_without_preload_content( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1444,12 +1444,23 @@ def fax_line_list( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1469,11 +1480,11 @@ def fax_line_list( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1527,12 +1538,23 @@ def fax_line_list_with_http_info( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1552,11 +1574,11 @@ def fax_line_list_with_http_info( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1610,12 +1632,23 @@ def fax_line_list_without_preload_content( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1635,11 +1668,11 @@ def fax_line_list_without_preload_content( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1770,7 +1803,7 @@ def fax_line_remove_user( ) -> FaxLineResponse: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest @@ -1835,7 +1868,7 @@ def fax_line_remove_user_with_http_info( ) -> ApiResponse[FaxLineResponse]: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest @@ -1900,7 +1933,7 @@ def fax_line_remove_user_without_preload_content( ) -> RESTResponseType: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest diff --git a/sdks/python/dropbox_sign/api/o_auth_api.py b/sdks/python/dropbox_sign/api/o_auth_api.py index 774f2049c..bedd1bfff 100644 --- a/sdks/python/dropbox_sign/api/o_auth_api.py +++ b/sdks/python/dropbox_sign/api/o_auth_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/report_api.py b/sdks/python/dropbox_sign/api/report_api.py index 56314a1eb..a31ee01f5 100644 --- a/sdks/python/dropbox_sign/api/report_api.py +++ b/sdks/python/dropbox_sign/api/report_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/signature_request_api.py b/sdks/python/dropbox_sign/api/signature_request_api.py index 98f08aed8..f78d1a219 100644 --- a/sdks/python/dropbox_sign/api/signature_request_api.py +++ b/sdks/python/dropbox_sign/api/signature_request_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/team_api.py b/sdks/python/dropbox_sign/api/team_api.py index cd2c24468..142d890c8 100644 --- a/sdks/python/dropbox_sign/api/team_api.py +++ b/sdks/python/dropbox_sign/api/team_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/template_api.py b/sdks/python/dropbox_sign/api/template_api.py index 9ddb3130e..87be9f0fd 100644 --- a/sdks/python/dropbox_sign/api/template_api.py +++ b/sdks/python/dropbox_sign/api/template_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/unclaimed_draft_api.py b/sdks/python/dropbox_sign/api/unclaimed_draft_api.py index 75be55e4e..620a71e90 100644 --- a/sdks/python/dropbox_sign/api/unclaimed_draft_api.py +++ b/sdks/python/dropbox_sign/api/unclaimed_draft_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api_client.py b/sdks/python/dropbox_sign/api_client.py index 1b2a6c711..16e766078 100644 --- a/sdks/python/dropbox_sign/api_client.py +++ b/sdks/python/dropbox_sign/api_client.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/configuration.py b/sdks/python/dropbox_sign/configuration.py index 949829704..016c4e591 100644 --- a/sdks/python/dropbox_sign/configuration.py +++ b/sdks/python/dropbox_sign/configuration.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/exceptions.py b/sdks/python/dropbox_sign/exceptions.py index d19f9220f..43300ceac 100644 --- a/sdks/python/dropbox_sign/exceptions.py +++ b/sdks/python/dropbox_sign/exceptions.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 from typing import Any, Optional diff --git a/sdks/python/dropbox_sign/models/__init__.py b/sdks/python/dropbox_sign/models/__init__.py index 71b8e6f5b..97af4020e 100644 --- a/sdks/python/dropbox_sign/models/__init__.py +++ b/sdks/python/dropbox_sign/models/__init__.py @@ -2,15 +2,15 @@ # flake8: noqa """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_create_request.py b/sdks/python/dropbox_sign/models/account_create_request.py index 62282b274..eb0d37416 100644 --- a/sdks/python/dropbox_sign/models/account_create_request.py +++ b/sdks/python/dropbox_sign/models/account_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_create_response.py b/sdks/python/dropbox_sign/models/account_create_response.py index b8ff5aed3..c1788e0e7 100644 --- a/sdks/python/dropbox_sign/models/account_create_response.py +++ b/sdks/python/dropbox_sign/models/account_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_get_response.py b/sdks/python/dropbox_sign/models/account_get_response.py index f40a2d677..1be99f48c 100644 --- a/sdks/python/dropbox_sign/models/account_get_response.py +++ b/sdks/python/dropbox_sign/models/account_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_response.py b/sdks/python/dropbox_sign/models/account_response.py index bf6e202fb..8af0a6fb5 100644 --- a/sdks/python/dropbox_sign/models/account_response.py +++ b/sdks/python/dropbox_sign/models/account_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_response_quotas.py b/sdks/python/dropbox_sign/models/account_response_quotas.py index 8c69e6bab..a58444549 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_response_usage.py b/sdks/python/dropbox_sign/models/account_response_usage.py index 6065a2230..8efc7a64b 100644 --- a/sdks/python/dropbox_sign/models/account_response_usage.py +++ b/sdks/python/dropbox_sign/models/account_response_usage.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_update_request.py b/sdks/python/dropbox_sign/models/account_update_request.py index 5e0f577ec..7b5c95ddf 100644 --- a/sdks/python/dropbox_sign/models/account_update_request.py +++ b/sdks/python/dropbox_sign/models/account_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_verify_request.py b/sdks/python/dropbox_sign/models/account_verify_request.py index 77e307efe..a3a95c352 100644 --- a/sdks/python/dropbox_sign/models/account_verify_request.py +++ b/sdks/python/dropbox_sign/models/account_verify_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_verify_response.py b/sdks/python/dropbox_sign/models/account_verify_response.py index 1fc490f81..c5f1960be 100644 --- a/sdks/python/dropbox_sign/models/account_verify_response.py +++ b/sdks/python/dropbox_sign/models/account_verify_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_verify_response_account.py b/sdks/python/dropbox_sign/models/account_verify_response_account.py index 715d9cea0..3724cd063 100644 --- a/sdks/python/dropbox_sign/models/account_verify_response_account.py +++ b/sdks/python/dropbox_sign/models/account_verify_response_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_create_request.py b/sdks/python/dropbox_sign/models/api_app_create_request.py index 14af7b247..4f7181b59 100644 --- a/sdks/python/dropbox_sign/models/api_app_create_request.py +++ b/sdks/python/dropbox_sign/models/api_app_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_get_response.py b/sdks/python/dropbox_sign/models/api_app_get_response.py index d9fe3f3f1..5c03394e6 100644 --- a/sdks/python/dropbox_sign/models/api_app_get_response.py +++ b/sdks/python/dropbox_sign/models/api_app_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_list_response.py b/sdks/python/dropbox_sign/models/api_app_list_response.py index f0272df9f..748cc9365 100644 --- a/sdks/python/dropbox_sign/models/api_app_list_response.py +++ b/sdks/python/dropbox_sign/models/api_app_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response.py b/sdks/python/dropbox_sign/models/api_app_response.py index 42f1f87fd..a1f0bf157 100644 --- a/sdks/python/dropbox_sign/models/api_app_response.py +++ b/sdks/python/dropbox_sign/models/api_app_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py index eeeae66cf..981f94d9f 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py +++ b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_options.py b/sdks/python/dropbox_sign/models/api_app_response_options.py index cf3ef4f42..751daf0de 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py index 7191f948a..c1ed456c8 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py +++ b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py index 18d77df90..734022f90 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_update_request.py b/sdks/python/dropbox_sign/models/api_app_update_request.py index c393ba062..e3f2a1abc 100644 --- a/sdks/python/dropbox_sign/models/api_app_update_request.py +++ b/sdks/python/dropbox_sign/models/api_app_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py index ed8fbfcc0..749ba54b1 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py index e49e0a733..de4b9a20a 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py index 5ec2b8c0d..91d471ccc 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_response.py index 75a8477e2..0812cb85d 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py index 60f57d13f..e340ab831 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py index e727d14cf..525dfa828 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_response.py b/sdks/python/dropbox_sign/models/embedded_edit_url_response.py index c35ee6362..6c8ecc37a 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_response.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py b/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py index be2f6d26c..3dfe4d2d2 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_sign_url_response.py b/sdks/python/dropbox_sign/models/embedded_sign_url_response.py index 6bc86e865..ca92cdc23 100644 --- a/sdks/python/dropbox_sign/models/embedded_sign_url_response.py +++ b/sdks/python/dropbox_sign/models/embedded_sign_url_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py b/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py index 4777554c1..6de5a5b8e 100644 --- a/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py +++ b/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/error_response.py b/sdks/python/dropbox_sign/models/error_response.py index 64ee3a32c..f85c24767 100644 --- a/sdks/python/dropbox_sign/models/error_response.py +++ b/sdks/python/dropbox_sign/models/error_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/error_response_error.py b/sdks/python/dropbox_sign/models/error_response_error.py index 244177c4d..6577b27e7 100644 --- a/sdks/python/dropbox_sign/models/error_response_error.py +++ b/sdks/python/dropbox_sign/models/error_response_error.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/event_callback_request.py b/sdks/python/dropbox_sign/models/event_callback_request.py index 84b205a31..768983736 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request.py +++ b/sdks/python/dropbox_sign/models/event_callback_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event.py b/sdks/python/dropbox_sign/models/event_callback_request_event.py index 470f382fd..971fff98b 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py b/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py index c9ca17c7e..572abb509 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_get_response.py b/sdks/python/dropbox_sign/models/fax_get_response.py index 15b1788bf..8c2b2249f 100644 --- a/sdks/python/dropbox_sign/models/fax_get_response.py +++ b/sdks/python/dropbox_sign/models/fax_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py index e4f92da3a..10419081a 100644 --- a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 @@ -32,7 +32,7 @@ class FaxLineAddUserRequest(BaseModel): FaxLineAddUserRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") + number: StrictStr = Field(description="The Fax Line number") account_id: Optional[StrictStr] = Field(default=None, description="Account ID") email_address: Optional[StrictStr] = Field( default=None, description="Email address" diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py index 94df88562..62b87eb08 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py index e7994f3f5..cbe1eea81 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py index c0d098bfc..ac8722d39 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py index 8cfe5ad2e..51f9da013 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_create_request.py b/sdks/python/dropbox_sign/models/fax_line_create_request.py index 459e36ee6..fddd8acf3 100644 --- a/sdks/python/dropbox_sign/models/fax_line_create_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 @@ -32,10 +32,13 @@ class FaxLineCreateRequest(BaseModel): FaxLineCreateRequest """ # noqa: E501 - area_code: StrictInt = Field(description="Area code") - country: StrictStr = Field(description="Country") - city: Optional[StrictStr] = Field(default=None, description="City") - account_id: Optional[StrictStr] = Field(default=None, description="Account ID") + area_code: StrictInt = Field(description="Area code of the new Fax Line") + country: StrictStr = Field(description="Country of the area code") + city: Optional[StrictStr] = Field(default=None, description="City of the area code") + account_id: Optional[StrictStr] = Field( + default=None, + description="Account ID of the account that will be assigned this new Fax Line", + ) __properties: ClassVar[List[str]] = ["area_code", "country", "city", "account_id"] @field_validator("country") diff --git a/sdks/python/dropbox_sign/models/fax_line_delete_request.py b/sdks/python/dropbox_sign/models/fax_line_delete_request.py index 140112ffa..265607f78 100644 --- a/sdks/python/dropbox_sign/models/fax_line_delete_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_delete_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 @@ -32,7 +32,7 @@ class FaxLineDeleteRequest(BaseModel): FaxLineDeleteRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") + number: StrictStr = Field(description="The Fax Line number") __properties: ClassVar[List[str]] = ["number"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/fax_line_list_response.py b/sdks/python/dropbox_sign/models/fax_line_list_response.py index d646b66e8..099c3cc55 100644 --- a/sdks/python/dropbox_sign/models/fax_line_list_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py index 710dc10cb..d75613bef 100644 --- a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 @@ -32,10 +32,12 @@ class FaxLineRemoveUserRequest(BaseModel): FaxLineRemoveUserRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") - account_id: Optional[StrictStr] = Field(default=None, description="Account ID") + number: StrictStr = Field(description="The Fax Line number") + account_id: Optional[StrictStr] = Field( + default=None, description="Account ID of the user to remove access" + ) email_address: Optional[StrictStr] = Field( - default=None, description="Email address" + default=None, description="Email address of the user to remove access" ) __properties: ClassVar[List[str]] = ["number", "account_id", "email_address"] diff --git a/sdks/python/dropbox_sign/models/fax_line_response.py b/sdks/python/dropbox_sign/models/fax_line_response.py index 4a4cd3578..a719bc9fa 100644 --- a/sdks/python/dropbox_sign/models/fax_line_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py index 9ebd7db5b..7d89f44cc 100644 --- a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py +++ b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_list_response.py b/sdks/python/dropbox_sign/models/fax_list_response.py index 97dd078e7..b62b406e1 100644 --- a/sdks/python/dropbox_sign/models/fax_list_response.py +++ b/sdks/python/dropbox_sign/models/fax_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_response.py b/sdks/python/dropbox_sign/models/fax_response.py index 9a5ffce3d..976606e37 100644 --- a/sdks/python/dropbox_sign/models/fax_response.py +++ b/sdks/python/dropbox_sign/models/fax_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_response_transmission.py b/sdks/python/dropbox_sign/models/fax_response_transmission.py index 1b1dc6e87..28cf397a0 100644 --- a/sdks/python/dropbox_sign/models/fax_response_transmission.py +++ b/sdks/python/dropbox_sign/models/fax_response_transmission.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_send_request.py b/sdks/python/dropbox_sign/models/fax_send_request.py index a26c775de..a8b3b3c1d 100644 --- a/sdks/python/dropbox_sign/models/fax_send_request.py +++ b/sdks/python/dropbox_sign/models/fax_send_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 @@ -32,24 +32,28 @@ class FaxSendRequest(BaseModel): FaxSendRequest """ # noqa: E501 - recipient: StrictStr = Field(description="Fax Send To Recipient") + recipient: StrictStr = Field( + description="Recipient of the fax Can be a phone number in E.164 format or email address" + ) sender: Optional[StrictStr] = Field( default=None, description="Fax Send From Sender (used only with fax number)" ) files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( - default=None, description="Fax File to Send" + default=None, + description="Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.", ) file_urls: Optional[List[StrictStr]] = Field( - default=None, description="Fax File URL to Send" + default=None, + description="Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.", ) test_mode: Optional[StrictBool] = Field( default=False, description="API Test Mode Setting" ) cover_page_to: Optional[StrictStr] = Field( - default=None, description="Fax Cover Page for Recipient" + default=None, description="Fax cover page recipient information" ) cover_page_from: Optional[StrictStr] = Field( - default=None, description="Fax Cover Page for Sender" + default=None, description="Fax cover page sender information" ) cover_page_message: Optional[StrictStr] = Field( default=None, description="Fax Cover Page Message" diff --git a/sdks/python/dropbox_sign/models/file_response.py b/sdks/python/dropbox_sign/models/file_response.py index e08fe26b4..e0479e3d6 100644 --- a/sdks/python/dropbox_sign/models/file_response.py +++ b/sdks/python/dropbox_sign/models/file_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/file_response_data_uri.py b/sdks/python/dropbox_sign/models/file_response_data_uri.py index 94613587d..c7c2e403f 100644 --- a/sdks/python/dropbox_sign/models/file_response_data_uri.py +++ b/sdks/python/dropbox_sign/models/file_response_data_uri.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/list_info_response.py b/sdks/python/dropbox_sign/models/list_info_response.py index 1f6cf2ad8..b51627288 100644 --- a/sdks/python/dropbox_sign/models/list_info_response.py +++ b/sdks/python/dropbox_sign/models/list_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py b/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py index 7f17c50f5..ff2aefb6b 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py b/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py index 02400c6a9..573036386 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_response.py b/sdks/python/dropbox_sign/models/o_auth_token_response.py index d9a1569c3..e42732a19 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_response.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/report_create_request.py b/sdks/python/dropbox_sign/models/report_create_request.py index d142b6d5b..4bed0f940 100644 --- a/sdks/python/dropbox_sign/models/report_create_request.py +++ b/sdks/python/dropbox_sign/models/report_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/report_create_response.py b/sdks/python/dropbox_sign/models/report_create_response.py index 7143a93ea..6fc7ec8e0 100644 --- a/sdks/python/dropbox_sign/models/report_create_response.py +++ b/sdks/python/dropbox_sign/models/report_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/report_response.py b/sdks/python/dropbox_sign/models/report_response.py index 7a41b74fd..2ed765c4a 100644 --- a/sdks/python/dropbox_sign/models/report_response.py +++ b/sdks/python/dropbox_sign/models/report_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py index 23c253846..a3250eb3c 100644 --- a/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py index c6b2b7032..6c122576b 100644 --- a/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py index 8733c885a..8912b4560 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py index 8bec42df4..2c7d080d7 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_get_response.py b/sdks/python/dropbox_sign/models/signature_request_get_response.py index 444d5beda..8a1c556f4 100644 --- a/sdks/python/dropbox_sign/models/signature_request_get_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_list_response.py b/sdks/python/dropbox_sign/models/signature_request_list_response.py index e5a08fdfa..02f8d7426 100644 --- a/sdks/python/dropbox_sign/models/signature_request_list_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_remind_request.py b/sdks/python/dropbox_sign/models/signature_request_remind_request.py index 32c150011..21483ce2a 100644 --- a/sdks/python/dropbox_sign/models/signature_request_remind_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_remind_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response.py b/sdks/python/dropbox_sign/models/signature_request_response.py index a79c0aad1..e367012a3 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_attachment.py b/sdks/python/dropbox_sign/models/signature_request_response_attachment.py index 5c5648510..a8f364ba7 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_attachment.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_attachment.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py index fd5117bd9..03fd81e16 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py index 22f87e272..229a9f245 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py index e6ea56624..b4605b54f 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py index 8f715aea2..db67d6872 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_base.py b/sdks/python/dropbox_sign/models/signature_request_response_data_base.py index 3999601fe..1e72f17e7 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_base.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py b/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py index 8c4d01dac..edd8ac007 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py index 5810aff16..97dd0ebf9 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py index 11c3618dc..a48b3d07e 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py index 9c9ae9cc5..b06f89be6 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py index cdd8d423e..94ea1c7f4 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py index f3eae53bd..f5a493c75 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py index cebf21665..8b531ece2 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py index 349299559..86461b32a 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py index 7fa2c6e71..df76cb604 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py index f32e60fec..15ffbb331 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_signatures.py b/sdks/python/dropbox_sign/models/signature_request_response_signatures.py index 70a26b495..0a964e5f8 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_signatures.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_signatures.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_send_request.py b/sdks/python/dropbox_sign/models/signature_request_send_request.py index 3618ed1c1..806a1def1 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py index 53c7efe26..9c4045a3e 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_update_request.py b/sdks/python/dropbox_sign/models/signature_request_update_request.py index c0c45afb5..37c4e18b2 100644 --- a/sdks/python/dropbox_sign/models/signature_request_update_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_attachment.py b/sdks/python/dropbox_sign/models/sub_attachment.py index 65aa53c45..a0c288d3a 100644 --- a/sdks/python/dropbox_sign/models/sub_attachment.py +++ b/sdks/python/dropbox_sign/models/sub_attachment.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py b/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py index e647cd8c1..d5d8edb45 100644 --- a/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py +++ b/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py b/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py index aef9b0ed2..dbd925d79 100644 --- a/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py +++ b/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_cc.py b/sdks/python/dropbox_sign/models/sub_cc.py index 5ea92108c..a0aa82906 100644 --- a/sdks/python/dropbox_sign/models/sub_cc.py +++ b/sdks/python/dropbox_sign/models/sub_cc.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_custom_field.py b/sdks/python/dropbox_sign/models/sub_custom_field.py index 3fe2bf546..aa837bcdc 100644 --- a/sdks/python/dropbox_sign/models/sub_custom_field.py +++ b/sdks/python/dropbox_sign/models/sub_custom_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_editor_options.py b/sdks/python/dropbox_sign/models/sub_editor_options.py index f67cfcbbd..7e4315cbe 100644 --- a/sdks/python/dropbox_sign/models/sub_editor_options.py +++ b/sdks/python/dropbox_sign/models/sub_editor_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_field_options.py b/sdks/python/dropbox_sign/models/sub_field_options.py index 95c6514f1..bd4ca3aa1 100644 --- a/sdks/python/dropbox_sign/models/sub_field_options.py +++ b/sdks/python/dropbox_sign/models/sub_field_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_group.py b/sdks/python/dropbox_sign/models/sub_form_field_group.py index 51a96961f..9a9964b90 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_group.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_group.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule.py b/sdks/python/dropbox_sign/models/sub_form_field_rule.py index 2ca3d4e11..345122638 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py b/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py index 0f5c2e2a2..2e8eedfae 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py b/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py index 03b534175..124a9212c 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py index 1d9a0dd51..0f05fbeee 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py index 9a93b890f..f1765d128 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py index dc16dd79b..157a66f5c 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py index 17e0b8a69..298b43a5a 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py index dfab88a88..331b61720 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py index 8865fdc9e..5244ac297 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py index c9fda0dc0..f8c9d0c54 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py index a5d640cba..8962b4cee 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py index b34e05863..69407f506 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py index 3c7a3cf18..e900a7500 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py index ff7c01f0d..b7f473dd3 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py index 77ee57590..318deab88 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py index e1d61ca05..e2ca1330f 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_merge_field.py b/sdks/python/dropbox_sign/models/sub_merge_field.py index 1db7477c9..dba544e80 100644 --- a/sdks/python/dropbox_sign/models/sub_merge_field.py +++ b/sdks/python/dropbox_sign/models/sub_merge_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_o_auth.py b/sdks/python/dropbox_sign/models/sub_o_auth.py index b0ec45aca..979d595aa 100644 --- a/sdks/python/dropbox_sign/models/sub_o_auth.py +++ b/sdks/python/dropbox_sign/models/sub_o_auth.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_options.py b/sdks/python/dropbox_sign/models/sub_options.py index 20d318b8b..bd4f00ae8 100644 --- a/sdks/python/dropbox_sign/models/sub_options.py +++ b/sdks/python/dropbox_sign/models/sub_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py b/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py index 5b4fbac5c..24671c921 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_signer.py b/sdks/python/dropbox_sign/models/sub_signature_request_signer.py index 495d43b21..ac567d564 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_signer.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py b/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py index a0dbbb9b6..44b6881d8 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signing_options.py b/sdks/python/dropbox_sign/models/sub_signing_options.py index 1b5ebebc8..e6cd96000 100644 --- a/sdks/python/dropbox_sign/models/sub_signing_options.py +++ b/sdks/python/dropbox_sign/models/sub_signing_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_team_response.py b/sdks/python/dropbox_sign/models/sub_team_response.py index 7477a0164..98e55e192 100644 --- a/sdks/python/dropbox_sign/models/sub_team_response.py +++ b/sdks/python/dropbox_sign/models/sub_team_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_template_role.py b/sdks/python/dropbox_sign/models/sub_template_role.py index 82c52f920..187fa77f9 100644 --- a/sdks/python/dropbox_sign/models/sub_template_role.py +++ b/sdks/python/dropbox_sign/models/sub_template_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py index e6eac58fb..fcc70e385 100644 --- a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py +++ b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py index 60a5c21b1..2154537e8 100644 --- a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py +++ b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py index 5c85661d0..218da2aea 100644 --- a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_add_member_request.py b/sdks/python/dropbox_sign/models/team_add_member_request.py index 08491820e..275ccf00f 100644 --- a/sdks/python/dropbox_sign/models/team_add_member_request.py +++ b/sdks/python/dropbox_sign/models/team_add_member_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_create_request.py b/sdks/python/dropbox_sign/models/team_create_request.py index bf97f938c..0c0c696ad 100644 --- a/sdks/python/dropbox_sign/models/team_create_request.py +++ b/sdks/python/dropbox_sign/models/team_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_get_info_response.py b/sdks/python/dropbox_sign/models/team_get_info_response.py index e9d858a54..3453baa20 100644 --- a/sdks/python/dropbox_sign/models/team_get_info_response.py +++ b/sdks/python/dropbox_sign/models/team_get_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_get_response.py b/sdks/python/dropbox_sign/models/team_get_response.py index c6a4a122a..65845b263 100644 --- a/sdks/python/dropbox_sign/models/team_get_response.py +++ b/sdks/python/dropbox_sign/models/team_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_info_response.py b/sdks/python/dropbox_sign/models/team_info_response.py index 233239b41..4c6ae507f 100644 --- a/sdks/python/dropbox_sign/models/team_info_response.py +++ b/sdks/python/dropbox_sign/models/team_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_invite_response.py b/sdks/python/dropbox_sign/models/team_invite_response.py index 28dcae72e..fbc7d130a 100644 --- a/sdks/python/dropbox_sign/models/team_invite_response.py +++ b/sdks/python/dropbox_sign/models/team_invite_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_invites_response.py b/sdks/python/dropbox_sign/models/team_invites_response.py index a664ef227..aa448daff 100644 --- a/sdks/python/dropbox_sign/models/team_invites_response.py +++ b/sdks/python/dropbox_sign/models/team_invites_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_member_response.py b/sdks/python/dropbox_sign/models/team_member_response.py index 467363a90..0930eaa85 100644 --- a/sdks/python/dropbox_sign/models/team_member_response.py +++ b/sdks/python/dropbox_sign/models/team_member_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_members_response.py b/sdks/python/dropbox_sign/models/team_members_response.py index 5ef8f105d..f150d6ef4 100644 --- a/sdks/python/dropbox_sign/models/team_members_response.py +++ b/sdks/python/dropbox_sign/models/team_members_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_parent_response.py b/sdks/python/dropbox_sign/models/team_parent_response.py index 14e9b971f..633b10b61 100644 --- a/sdks/python/dropbox_sign/models/team_parent_response.py +++ b/sdks/python/dropbox_sign/models/team_parent_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_remove_member_request.py b/sdks/python/dropbox_sign/models/team_remove_member_request.py index e4266772f..d21215dca 100644 --- a/sdks/python/dropbox_sign/models/team_remove_member_request.py +++ b/sdks/python/dropbox_sign/models/team_remove_member_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_response.py b/sdks/python/dropbox_sign/models/team_response.py index a1364ddd1..57bec3332 100644 --- a/sdks/python/dropbox_sign/models/team_response.py +++ b/sdks/python/dropbox_sign/models/team_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_sub_teams_response.py b/sdks/python/dropbox_sign/models/team_sub_teams_response.py index 97c1fd5c1..6d6b76c23 100644 --- a/sdks/python/dropbox_sign/models/team_sub_teams_response.py +++ b/sdks/python/dropbox_sign/models/team_sub_teams_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_update_request.py b/sdks/python/dropbox_sign/models/team_update_request.py index 4eef699dc..e7bdb4307 100644 --- a/sdks/python/dropbox_sign/models/team_update_request.py +++ b/sdks/python/dropbox_sign/models/team_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_add_user_request.py b/sdks/python/dropbox_sign/models/template_add_user_request.py index a842890f4..34c4ed62d 100644 --- a/sdks/python/dropbox_sign/models/template_add_user_request.py +++ b/sdks/python/dropbox_sign/models/template_add_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py index de35b19eb..983d872f7 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py index d27401f86..5e728e79d 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py index 604fbf0ef..be23c205a 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_request.py b/sdks/python/dropbox_sign/models/template_create_request.py index 0f453b4b9..fa6df563c 100644 --- a/sdks/python/dropbox_sign/models/template_create_request.py +++ b/sdks/python/dropbox_sign/models/template_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_response.py b/sdks/python/dropbox_sign/models/template_create_response.py index 02102b69b..a42054f3c 100644 --- a/sdks/python/dropbox_sign/models/template_create_response.py +++ b/sdks/python/dropbox_sign/models/template_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_response_template.py b/sdks/python/dropbox_sign/models/template_create_response_template.py index 281a196f8..e4f253ef0 100644 --- a/sdks/python/dropbox_sign/models/template_create_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_edit_response.py b/sdks/python/dropbox_sign/models/template_edit_response.py index cf1542494..05b99f4c3 100644 --- a/sdks/python/dropbox_sign/models/template_edit_response.py +++ b/sdks/python/dropbox_sign/models/template_edit_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_get_response.py b/sdks/python/dropbox_sign/models/template_get_response.py index c9976881b..a32292b4f 100644 --- a/sdks/python/dropbox_sign/models/template_get_response.py +++ b/sdks/python/dropbox_sign/models/template_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_list_response.py b/sdks/python/dropbox_sign/models/template_list_response.py index a7c4f7c7d..5deebe214 100644 --- a/sdks/python/dropbox_sign/models/template_list_response.py +++ b/sdks/python/dropbox_sign/models/template_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_remove_user_request.py b/sdks/python/dropbox_sign/models/template_remove_user_request.py index 7c1eb4d8c..565c47e32 100644 --- a/sdks/python/dropbox_sign/models/template_remove_user_request.py +++ b/sdks/python/dropbox_sign/models/template_remove_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index 88bdb041e..01f36b353 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_account.py b/sdks/python/dropbox_sign/models/template_response_account.py index 09ddc2130..71358ff84 100644 --- a/sdks/python/dropbox_sign/models/template_response_account.py +++ b/sdks/python/dropbox_sign/models/template_response_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_account_quota.py b/sdks/python/dropbox_sign/models/template_response_account_quota.py index bcccd2d25..6c03effe9 100644 --- a/sdks/python/dropbox_sign/models/template_response_account_quota.py +++ b/sdks/python/dropbox_sign/models/template_response_account_quota.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_cc_role.py b/sdks/python/dropbox_sign/models/template_response_cc_role.py index 88cd630eb..8c005227d 100644 --- a/sdks/python/dropbox_sign/models/template_response_cc_role.py +++ b/sdks/python/dropbox_sign/models/template_response_cc_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document.py b/sdks/python/dropbox_sign/models/template_response_document.py index 27f7c9b7b..56e887bd0 100644 --- a/sdks/python/dropbox_sign/models/template_response_document.py +++ b/sdks/python/dropbox_sign/models/template_response_document.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py index 7a9e276ff..a7d2fa60c 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py index 62d20d94f..4edf644c2 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py index 489a15d0c..760dd57a4 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group.py b/sdks/python/dropbox_sign/models/template_response_document_field_group.py index e8492546d..201bd139e 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py index 9409fac83..e5ade9d4e 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py index 210bf9f3f..62f6d5f5b 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py index 5e6c23b99..29c4ff1e8 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py index 60469a645..9b466fa1c 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py index de5c1eb0a..65b253c5d 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py index 5f0ad6384..90f0c1f25 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py index 03003ab26..bc8512b4f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py index aa9126b61..7e76f9e27 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py index 166fe3330..7e742cebe 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py index 66322b76f..c04d1b550 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py index 8c6e26f01..4c16302d2 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py index 2ebc79440..ea1c2b787 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py index fe923c931..3a9bf86e0 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py index db70fb277..8444e77d8 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py index 3618481e3..43106f1b1 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py index 9c4534c48..884425354 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py index 3d85ef946..e0701f1cc 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py index 8e27c3c54..dbd12110f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py index 26e309e90..7fe3d5925 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py index 552b7a87e..b3b5d4aff 100644 --- a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py +++ b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_signer_role.py b/sdks/python/dropbox_sign/models/template_response_signer_role.py index 8f013c4a8..aab8250c4 100644 --- a/sdks/python/dropbox_sign/models/template_response_signer_role.py +++ b/sdks/python/dropbox_sign/models/template_response_signer_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_update_files_request.py b/sdks/python/dropbox_sign/models/template_update_files_request.py index 9aed90b10..e8d3f22cd 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_request.py +++ b/sdks/python/dropbox_sign/models/template_update_files_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_update_files_response.py b/sdks/python/dropbox_sign/models/template_update_files_response.py index d8a4728dc..d2c07763a 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_update_files_response_template.py b/sdks/python/dropbox_sign/models/template_update_files_response_template.py index ba5a06762..a8fb50fa3 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response_template.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py index 353355121..33b165023 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py index 798121996..a09307d19 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py index 207649f9c..2833e239b 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py index 334c47d70..11ae0d902 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py index 5461f8702..4b84d1031 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_response.py b/sdks/python/dropbox_sign/models/unclaimed_draft_response.py index 1678b95ea..1cd950950 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_response.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/warning_response.py b/sdks/python/dropbox_sign/models/warning_response.py index 67a037a1b..f5aa1277d 100644 --- a/sdks/python/dropbox_sign/models/warning_response.py +++ b/sdks/python/dropbox_sign/models/warning_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/rest.py b/sdks/python/dropbox_sign/rest.py index 877df1cd8..b369c3fde 100644 --- a/sdks/python/dropbox_sign/rest.py +++ b/sdks/python/dropbox_sign/rest.py @@ -1,15 +1,15 @@ # coding: utf-8 """ -Dropbox Sign API + Dropbox Sign API -Dropbox Sign v3 API + Dropbox Sign v3 API -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by OpenAPI Generator (https://openapi-generator.tech) + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) -Do not edit the class manually. + Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/ruby/docs/FaxApi.md b/sdks/ruby/docs/FaxApi.md index a0e05a605..a260d58dc 100644 --- a/sdks/ruby/docs/FaxApi.md +++ b/sdks/ruby/docs/FaxApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Examples @@ -83,7 +83,7 @@ nil (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Examples @@ -152,7 +152,7 @@ end Get Fax -Returns information about fax +Returns information about a Fax ### Examples @@ -221,7 +221,7 @@ end Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Examples @@ -269,8 +269,8 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `page` | **Integer** | Page | [optional][default to 1] | -| `page_size` | **Integer** | Page size | [optional][default to 20] | +| `page` | **Integer** | Which page number of the Fax List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | ### Return type @@ -292,7 +292,7 @@ end Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Examples diff --git a/sdks/ruby/docs/FaxLineAddUserRequest.md b/sdks/ruby/docs/FaxLineAddUserRequest.md index 272d38367..f5339aea7 100644 --- a/sdks/ruby/docs/FaxLineAddUserRequest.md +++ b/sdks/ruby/docs/FaxLineAddUserRequest.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `account_id` | ```String``` | Account ID | | | `email_address` | ```String``` | Email address | | diff --git a/sdks/ruby/docs/FaxLineApi.md b/sdks/ruby/docs/FaxLineApi.md index 49309267e..f7687b9e3 100644 --- a/sdks/ruby/docs/FaxLineApi.md +++ b/sdks/ruby/docs/FaxLineApi.md @@ -90,7 +90,7 @@ end Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Examples @@ -135,10 +135,10 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `country` | **String** | Filter area codes by country. | | -| `state` | **String** | Filter area codes by state. | [optional] | -| `province` | **String** | Filter area codes by province. | [optional] | -| `city` | **String** | Filter area codes by city. | [optional] | +| `country` | **String** | Filter area codes by country | | +| `state` | **String** | Filter area codes by state | [optional] | +| `province` | **String** | Filter area codes by province | [optional] | +| `city` | **String** | Filter area codes by city | [optional] | ### Return type @@ -160,7 +160,7 @@ end Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Examples @@ -345,7 +345,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number` | **String** | The Fax Line number. | | +| `number` | **String** | The Fax Line number | | ### Return type @@ -413,9 +413,9 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **String** | Account ID | [optional] | -| `page` | **Integer** | Page | [optional][default to 1] | -| `page_size` | **Integer** | Page size | [optional][default to 20] | -| `show_team_lines` | **Boolean** | Show team lines | [optional] | +| `page` | **Integer** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | +| `show_team_lines` | **Boolean** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -437,7 +437,7 @@ end Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Examples diff --git a/sdks/ruby/docs/FaxLineCreateRequest.md b/sdks/ruby/docs/FaxLineCreateRequest.md index bbe5312c6..5359e4073 100644 --- a/sdks/ruby/docs/FaxLineCreateRequest.md +++ b/sdks/ruby/docs/FaxLineCreateRequest.md @@ -6,8 +6,8 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `area_code`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | ```String``` | Country | | -| `city` | ```String``` | City | | -| `account_id` | ```String``` | Account ID | | +| `area_code`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | ```String``` | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `account_id` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/sdks/ruby/docs/FaxLineDeleteRequest.md b/sdks/ruby/docs/FaxLineDeleteRequest.md index 5c781f3b4..fc910e543 100644 --- a/sdks/ruby/docs/FaxLineDeleteRequest.md +++ b/sdks/ruby/docs/FaxLineDeleteRequest.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/sdks/ruby/docs/FaxLineRemoveUserRequest.md b/sdks/ruby/docs/FaxLineRemoveUserRequest.md index 98388f6f4..4156b6130 100644 --- a/sdks/ruby/docs/FaxLineRemoveUserRequest.md +++ b/sdks/ruby/docs/FaxLineRemoveUserRequest.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `account_id` | ```String``` | Account ID | | -| `email_address` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `account_id` | ```String``` | Account ID of the user to remove access | | +| `email_address` | ```String``` | Email address of the user to remove access | | diff --git a/sdks/ruby/docs/FaxSendRequest.md b/sdks/ruby/docs/FaxSendRequest.md index 6217af9f6..af96a2357 100644 --- a/sdks/ruby/docs/FaxSendRequest.md +++ b/sdks/ruby/docs/FaxSendRequest.md @@ -6,13 +6,13 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```Array``` | Fax File to Send | | -| `file_urls` | ```Array``` | Fax File URL to Send | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `test_mode` | ```Boolean``` | API Test Mode Setting | [default to false] | -| `cover_page_to` | ```String``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```String``` | Fax Cover Page for Sender | | +| `cover_page_to` | ```String``` | Fax cover page recipient information | | +| `cover_page_from` | ```String``` | Fax cover page sender information | | | `cover_page_message` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb index 2df3c1851..b6685eb60 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb @@ -23,7 +23,7 @@ def initialize(api_client = ApiClient.default) @api_client = api_client end # Delete Fax - # Deletes the specified Fax from the system. + # Deletes the specified Fax from the system # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [nil] @@ -33,7 +33,7 @@ def fax_delete(fax_id, opts = {}) end # Delete Fax - # Deletes the specified Fax from the system. + # Deletes the specified Fax from the system # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -90,7 +90,7 @@ def fax_delete_with_http_info(fax_id, opts = {}) end # Download Fax Files - # Downloads fax files + # Downloads files associated with a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [File] @@ -100,7 +100,7 @@ def fax_files(fax_id, opts = {}) end # Download Fax Files - # Downloads fax files + # Downloads files associated with a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers @@ -184,7 +184,7 @@ def fax_files_with_http_info(fax_id, opts = {}) end # Get Fax - # Returns information about fax + # Returns information about a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [FaxGetResponse] @@ -194,7 +194,7 @@ def fax_get(fax_id, opts = {}) end # Get Fax - # Returns information about fax + # Returns information about a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers @@ -278,10 +278,10 @@ def fax_get_with_http_info(fax_id, opts = {}) end # Lists Faxes - # Returns properties of multiple faxes + # Returns properties of multiple Faxes # @param [Hash] opts the optional parameters - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) + # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) # @return [FaxListResponse] def fax_list(opts = {}) data, _status_code, _headers = fax_list_with_http_info(opts) @@ -289,10 +289,10 @@ def fax_list(opts = {}) end # Lists Faxes - # Returns properties of multiple faxes + # Returns properties of multiple Faxes # @param [Hash] opts the optional parameters - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) + # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) # @return [Array<(FaxListResponse, Integer, Hash)>] FaxListResponse data, response status code and response headers def fax_list_with_http_info(opts = {}) if @api_client.config.debugging @@ -384,7 +384,7 @@ def fax_list_with_http_info(opts = {}) end # Send Fax - # Action to prepare and send a fax + # Creates and sends a new Fax with the submitted file(s) # @param fax_send_request [FaxSendRequest] # @param [Hash] opts the optional parameters # @return [FaxGetResponse] @@ -394,7 +394,7 @@ def fax_send(fax_send_request, opts = {}) end # Send Fax - # Action to prepare and send a fax + # Creates and sends a new Fax with the submitted file(s) # @param fax_send_request [FaxSendRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb index a0b9677db..986673dcf 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb @@ -132,12 +132,12 @@ def fax_line_add_user_with_http_info(fax_line_add_user_request, opts = {}) end # Get Available Fax Line Area Codes - # Returns a response with the area codes available for a given state/province and city. - # @param country [String] Filter area codes by country. + # Returns a list of available area codes for a given state/province and city + # @param country [String] Filter area codes by country # @param [Hash] opts the optional parameters - # @option opts [String] :state Filter area codes by state. - # @option opts [String] :province Filter area codes by province. - # @option opts [String] :city Filter area codes by city. + # @option opts [String] :state Filter area codes by state + # @option opts [String] :province Filter area codes by province + # @option opts [String] :city Filter area codes by city # @return [FaxLineAreaCodeGetResponse] def fax_line_area_code_get(country, opts = {}) data, _status_code, _headers = fax_line_area_code_get_with_http_info(country, opts) @@ -145,12 +145,12 @@ def fax_line_area_code_get(country, opts = {}) end # Get Available Fax Line Area Codes - # Returns a response with the area codes available for a given state/province and city. - # @param country [String] Filter area codes by country. + # Returns a list of available area codes for a given state/province and city + # @param country [String] Filter area codes by country # @param [Hash] opts the optional parameters - # @option opts [String] :state Filter area codes by state. - # @option opts [String] :province Filter area codes by province. - # @option opts [String] :city Filter area codes by city. + # @option opts [String] :state Filter area codes by state + # @option opts [String] :province Filter area codes by province + # @option opts [String] :city Filter area codes by city # @return [Array<(FaxLineAreaCodeGetResponse, Integer, Hash)>] FaxLineAreaCodeGetResponse data, response status code and response headers def fax_line_area_code_get_with_http_info(country, opts = {}) if @api_client.config.debugging @@ -249,7 +249,7 @@ def fax_line_area_code_get_with_http_info(country, opts = {}) end # Purchase Fax Line - # Purchases a new Fax Line. + # Purchases a new Fax Line # @param fax_line_create_request [FaxLineCreateRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -259,7 +259,7 @@ def fax_line_create(fax_line_create_request, opts = {}) end # Purchase Fax Line - # Purchases a new Fax Line. + # Purchases a new Fax Line # @param fax_line_create_request [FaxLineCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers @@ -441,7 +441,7 @@ def fax_line_delete_with_http_info(fax_line_delete_request, opts = {}) # Get Fax Line # Returns the properties and settings of a Fax Line. - # @param number [String] The Fax Line number. + # @param number [String] The Fax Line number # @param [Hash] opts the optional parameters # @return [FaxLineResponse] def fax_line_get(number, opts = {}) @@ -451,7 +451,7 @@ def fax_line_get(number, opts = {}) # Get Fax Line # Returns the properties and settings of a Fax Line. - # @param number [String] The Fax Line number. + # @param number [String] The Fax Line number # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers def fax_line_get_with_http_info(number, opts = {}) @@ -538,9 +538,9 @@ def fax_line_get_with_http_info(number, opts = {}) # Returns the properties and settings of multiple Fax Lines. # @param [Hash] opts the optional parameters # @option opts [String] :account_id Account ID - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) - # @option opts [Boolean] :show_team_lines Show team lines + # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) + # @option opts [Boolean] :show_team_lines Include Fax Lines belonging to team members in the list # @return [FaxLineListResponse] def fax_line_list(opts = {}) data, _status_code, _headers = fax_line_list_with_http_info(opts) @@ -551,9 +551,9 @@ def fax_line_list(opts = {}) # Returns the properties and settings of multiple Fax Lines. # @param [Hash] opts the optional parameters # @option opts [String] :account_id Account ID - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) - # @option opts [Boolean] :show_team_lines Show team lines + # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) + # @option opts [Boolean] :show_team_lines Include Fax Lines belonging to team members in the list # @return [Array<(FaxLineListResponse, Integer, Hash)>] FaxLineListResponse data, response status code and response headers def fax_line_list_with_http_info(opts = {}) if @api_client.config.debugging @@ -635,7 +635,7 @@ def fax_line_list_with_http_info(opts = {}) end # Remove Fax Line Access - # Removes a user's access to the specified Fax Line. + # Removes a user's access to the specified Fax Line # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -645,7 +645,7 @@ def fax_line_remove_user(fax_line_remove_user_request, opts = {}) end # Remove Fax Line Access - # Removes a user's access to the specified Fax Line. + # Removes a user's access to the specified Fax Line # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb index d2b04a378..37dec78c8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxLineAddUserRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb index 16f9ebdde..06b6b356a 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb @@ -18,19 +18,19 @@ module Dropbox module Dropbox::Sign class FaxLineCreateRequest - # Area code + # Area code of the new Fax Line # @return [Integer] attr_accessor :area_code - # Country + # Country of the area code # @return [String] attr_accessor :country - # City + # City of the area code # @return [String] attr_accessor :city - # Account ID + # Account ID of the account that will be assigned this new Fax Line # @return [String] attr_accessor :account_id diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb index cdb344e44..a8fac5786 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxLineDeleteRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb index 3908c50fb..b6ed3e951 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb @@ -18,15 +18,15 @@ module Dropbox module Dropbox::Sign class FaxLineRemoveUserRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number - # Account ID + # Account ID of the user to remove access # @return [String] attr_accessor :account_id - # Email address + # Email address of the user to remove access # @return [String] attr_accessor :email_address diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb index 18616cee1..098737b4e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxSendRequest - # Fax Send To Recipient + # Recipient of the fax Can be a phone number in E.164 format or email address # @return [String] attr_accessor :recipient @@ -26,11 +26,11 @@ class FaxSendRequest # @return [String] attr_accessor :sender - # Fax File to Send + # Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. # @return [Array] attr_accessor :files - # Fax File URL to Send + # Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. # @return [Array] attr_accessor :file_urls @@ -38,11 +38,11 @@ class FaxSendRequest # @return [Boolean] attr_accessor :test_mode - # Fax Cover Page for Recipient + # Fax cover page recipient information # @return [String] attr_accessor :cover_page_to - # Fax Cover Page for Sender + # Fax cover page sender information # @return [String] attr_accessor :cover_page_from From 0c3c659a2fda68fd618d627be958f2b3b7e3b962 Mon Sep 17 00:00:00 2001 From: Jen Young Date: Mon, 3 Feb 2025 10:25:30 -0800 Subject: [PATCH 3/3] Add python changes --- sdks/python/dropbox_sign/__init__.py | 12 ++++++------ sdks/python/dropbox_sign/api/account_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/api_app_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/bulk_send_job_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/embedded_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/fax_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/fax_line_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/o_auth_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/report_api.py | 12 ++++++------ .../python/dropbox_sign/api/signature_request_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/team_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/template_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/unclaimed_draft_api.py | 12 ++++++------ sdks/python/dropbox_sign/api_client.py | 12 ++++++------ sdks/python/dropbox_sign/configuration.py | 12 ++++++------ sdks/python/dropbox_sign/exceptions.py | 12 ++++++------ sdks/python/dropbox_sign/models/__init__.py | 12 ++++++------ .../dropbox_sign/models/account_create_request.py | 12 ++++++------ .../dropbox_sign/models/account_create_response.py | 12 ++++++------ .../dropbox_sign/models/account_get_response.py | 12 ++++++------ sdks/python/dropbox_sign/models/account_response.py | 12 ++++++------ .../dropbox_sign/models/account_response_quotas.py | 12 ++++++------ .../dropbox_sign/models/account_response_usage.py | 12 ++++++------ .../dropbox_sign/models/account_update_request.py | 12 ++++++------ .../dropbox_sign/models/account_verify_request.py | 12 ++++++------ .../dropbox_sign/models/account_verify_response.py | 12 ++++++------ .../models/account_verify_response_account.py | 12 ++++++------ .../dropbox_sign/models/api_app_create_request.py | 12 ++++++------ .../dropbox_sign/models/api_app_get_response.py | 12 ++++++------ .../dropbox_sign/models/api_app_list_response.py | 12 ++++++------ sdks/python/dropbox_sign/models/api_app_response.py | 12 ++++++------ .../dropbox_sign/models/api_app_response_o_auth.py | 12 ++++++------ .../dropbox_sign/models/api_app_response_options.py | 12 ++++++------ .../models/api_app_response_owner_account.py | 12 ++++++------ .../api_app_response_white_labeling_options.py | 12 ++++++------ .../dropbox_sign/models/api_app_update_request.py | 12 ++++++------ .../models/bulk_send_job_get_response.py | 12 ++++++------ .../bulk_send_job_get_response_signature_requests.py | 12 ++++++------ .../models/bulk_send_job_list_response.py | 12 ++++++------ .../dropbox_sign/models/bulk_send_job_response.py | 12 ++++++------ .../models/bulk_send_job_send_response.py | 12 ++++++------ .../dropbox_sign/models/embedded_edit_url_request.py | 12 ++++++------ .../models/embedded_edit_url_response.py | 12 ++++++------ .../models/embedded_edit_url_response_embedded.py | 12 ++++++------ .../models/embedded_sign_url_response.py | 12 ++++++------ .../models/embedded_sign_url_response_embedded.py | 12 ++++++------ sdks/python/dropbox_sign/models/error_response.py | 12 ++++++------ .../dropbox_sign/models/error_response_error.py | 12 ++++++------ .../dropbox_sign/models/event_callback_request.py | 12 ++++++------ .../models/event_callback_request_event.py | 12 ++++++------ .../models/event_callback_request_event_metadata.py | 12 ++++++------ sdks/python/dropbox_sign/models/fax_get_response.py | 12 ++++++------ .../dropbox_sign/models/fax_line_add_user_request.py | 12 ++++++------ .../models/fax_line_area_code_get_country_enum.py | 12 ++++++------ .../models/fax_line_area_code_get_province_enum.py | 12 ++++++------ .../models/fax_line_area_code_get_response.py | 12 ++++++------ .../models/fax_line_area_code_get_state_enum.py | 12 ++++++------ .../dropbox_sign/models/fax_line_create_request.py | 12 ++++++------ .../dropbox_sign/models/fax_line_delete_request.py | 12 ++++++------ .../dropbox_sign/models/fax_line_list_response.py | 12 ++++++------ .../models/fax_line_remove_user_request.py | 12 ++++++------ sdks/python/dropbox_sign/models/fax_line_response.py | 12 ++++++------ .../models/fax_line_response_fax_line.py | 12 ++++++------ sdks/python/dropbox_sign/models/fax_list_response.py | 12 ++++++------ sdks/python/dropbox_sign/models/fax_response.py | 12 ++++++------ .../dropbox_sign/models/fax_response_transmission.py | 12 ++++++------ sdks/python/dropbox_sign/models/fax_send_request.py | 12 ++++++------ sdks/python/dropbox_sign/models/file_response.py | 12 ++++++------ .../dropbox_sign/models/file_response_data_uri.py | 12 ++++++------ .../python/dropbox_sign/models/list_info_response.py | 12 ++++++------ .../models/o_auth_token_generate_request.py | 12 ++++++------ .../models/o_auth_token_refresh_request.py | 12 ++++++------ .../dropbox_sign/models/o_auth_token_response.py | 12 ++++++------ .../dropbox_sign/models/report_create_request.py | 12 ++++++------ .../dropbox_sign/models/report_create_response.py | 12 ++++++------ sdks/python/dropbox_sign/models/report_response.py | 12 ++++++------ ...est_bulk_create_embedded_with_template_request.py | 12 ++++++------ ...nature_request_bulk_send_with_template_request.py | 12 ++++++------ .../signature_request_create_embedded_request.py | 12 ++++++------ ..._request_create_embedded_with_template_request.py | 12 ++++++------ .../models/signature_request_get_response.py | 12 ++++++------ .../models/signature_request_list_response.py | 12 ++++++------ .../models/signature_request_remind_request.py | 12 ++++++------ .../models/signature_request_response.py | 12 ++++++------ .../models/signature_request_response_attachment.py | 12 ++++++------ .../signature_request_response_custom_field_base.py | 12 ++++++------ ...gnature_request_response_custom_field_checkbox.py | 12 ++++++------ .../signature_request_response_custom_field_text.py | 12 ++++++------ ...nature_request_response_custom_field_type_enum.py | 12 ++++++------ .../models/signature_request_response_data_base.py | 12 ++++++------ .../signature_request_response_data_type_enum.py | 12 ++++++------ ...signature_request_response_data_value_checkbox.py | 12 ++++++------ ...ure_request_response_data_value_checkbox_merge.py | 12 ++++++------ ...nature_request_response_data_value_date_signed.py | 12 ++++++------ ...signature_request_response_data_value_dropdown.py | 12 ++++++------ ...signature_request_response_data_value_initials.py | 12 ++++++------ .../signature_request_response_data_value_radio.py | 12 ++++++------ ...ignature_request_response_data_value_signature.py | 12 ++++++------ .../signature_request_response_data_value_text.py | 12 ++++++------ ...gnature_request_response_data_value_text_merge.py | 12 ++++++------ .../models/signature_request_response_signatures.py | 12 ++++++------ .../models/signature_request_send_request.py | 12 ++++++------ .../signature_request_send_with_template_request.py | 12 ++++++------ .../models/signature_request_update_request.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_attachment.py | 12 ++++++------ .../dropbox_sign/models/sub_bulk_signer_list.py | 12 ++++++------ .../models/sub_bulk_signer_list_custom_field.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_cc.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_custom_field.py | 12 ++++++------ .../python/dropbox_sign/models/sub_editor_options.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_field_options.py | 12 ++++++------ .../dropbox_sign/models/sub_form_field_group.py | 12 ++++++------ .../dropbox_sign/models/sub_form_field_rule.py | 12 ++++++------ .../models/sub_form_field_rule_action.py | 12 ++++++------ .../models/sub_form_field_rule_trigger.py | 12 ++++++------ .../models/sub_form_fields_per_document_base.py | 12 ++++++------ .../models/sub_form_fields_per_document_checkbox.py | 12 ++++++------ .../sub_form_fields_per_document_checkbox_merge.py | 12 ++++++------ .../sub_form_fields_per_document_date_signed.py | 12 ++++++------ .../models/sub_form_fields_per_document_dropdown.py | 12 ++++++------ .../models/sub_form_fields_per_document_font_enum.py | 12 ++++++------ .../models/sub_form_fields_per_document_hyperlink.py | 12 ++++++------ .../models/sub_form_fields_per_document_initials.py | 12 ++++++------ .../models/sub_form_fields_per_document_radio.py | 12 ++++++------ .../models/sub_form_fields_per_document_signature.py | 12 ++++++------ .../models/sub_form_fields_per_document_text.py | 12 ++++++------ .../sub_form_fields_per_document_text_merge.py | 12 ++++++------ .../models/sub_form_fields_per_document_type_enum.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_merge_field.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_o_auth.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_options.py | 12 ++++++------ .../models/sub_signature_request_grouped_signers.py | 12 ++++++------ .../models/sub_signature_request_signer.py | 12 ++++++------ .../models/sub_signature_request_template_signer.py | 12 ++++++------ .../dropbox_sign/models/sub_signing_options.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_team_response.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_template_role.py | 12 ++++++------ .../models/sub_unclaimed_draft_signer.py | 12 ++++++------ .../models/sub_unclaimed_draft_template_signer.py | 12 ++++++------ .../models/sub_white_labeling_options.py | 12 ++++++------ .../dropbox_sign/models/team_add_member_request.py | 12 ++++++------ .../dropbox_sign/models/team_create_request.py | 12 ++++++------ .../dropbox_sign/models/team_get_info_response.py | 12 ++++++------ sdks/python/dropbox_sign/models/team_get_response.py | 12 ++++++------ .../python/dropbox_sign/models/team_info_response.py | 12 ++++++------ .../dropbox_sign/models/team_invite_response.py | 12 ++++++------ .../dropbox_sign/models/team_invites_response.py | 12 ++++++------ .../dropbox_sign/models/team_member_response.py | 12 ++++++------ .../dropbox_sign/models/team_members_response.py | 12 ++++++------ .../dropbox_sign/models/team_parent_response.py | 12 ++++++------ .../models/team_remove_member_request.py | 12 ++++++------ sdks/python/dropbox_sign/models/team_response.py | 12 ++++++------ .../dropbox_sign/models/team_sub_teams_response.py | 12 ++++++------ .../dropbox_sign/models/team_update_request.py | 12 ++++++------ .../dropbox_sign/models/template_add_user_request.py | 12 ++++++------ .../models/template_create_embedded_draft_request.py | 12 ++++++------ .../template_create_embedded_draft_response.py | 12 ++++++------ ...mplate_create_embedded_draft_response_template.py | 12 ++++++------ .../dropbox_sign/models/template_create_request.py | 12 ++++++------ .../dropbox_sign/models/template_create_response.py | 12 ++++++------ .../models/template_create_response_template.py | 12 ++++++------ .../dropbox_sign/models/template_edit_response.py | 12 ++++++------ .../dropbox_sign/models/template_get_response.py | 12 ++++++------ .../dropbox_sign/models/template_list_response.py | 12 ++++++------ .../models/template_remove_user_request.py | 12 ++++++------ sdks/python/dropbox_sign/models/template_response.py | 12 ++++++------ .../dropbox_sign/models/template_response_account.py | 12 ++++++------ .../models/template_response_account_quota.py | 12 ++++++------ .../dropbox_sign/models/template_response_cc_role.py | 12 ++++++------ .../models/template_response_document.py | 12 ++++++------ .../template_response_document_custom_field_base.py | 12 ++++++------ ...mplate_response_document_custom_field_checkbox.py | 12 ++++++------ .../template_response_document_custom_field_text.py | 12 ++++++------ .../models/template_response_document_field_group.py | 12 ++++++------ .../template_response_document_field_group_rule.py | 12 ++++++------ .../template_response_document_form_field_base.py | 12 ++++++------ ...template_response_document_form_field_checkbox.py | 12 ++++++------ ...plate_response_document_form_field_date_signed.py | 12 ++++++------ ...template_response_document_form_field_dropdown.py | 12 ++++++------ ...emplate_response_document_form_field_hyperlink.py | 12 ++++++------ ...template_response_document_form_field_initials.py | 12 ++++++------ .../template_response_document_form_field_radio.py | 12 ++++++------ ...emplate_response_document_form_field_signature.py | 12 ++++++------ .../template_response_document_form_field_text.py | 12 ++++++------ .../template_response_document_static_field_base.py | 12 ++++++------ ...mplate_response_document_static_field_checkbox.py | 12 ++++++------ ...ate_response_document_static_field_date_signed.py | 12 ++++++------ ...mplate_response_document_static_field_dropdown.py | 12 ++++++------ ...plate_response_document_static_field_hyperlink.py | 12 ++++++------ ...mplate_response_document_static_field_initials.py | 12 ++++++------ .../template_response_document_static_field_radio.py | 12 ++++++------ ...plate_response_document_static_field_signature.py | 12 ++++++------ .../template_response_document_static_field_text.py | 12 ++++++------ .../template_response_field_avg_text_length.py | 12 ++++++------ .../models/template_response_signer_role.py | 12 ++++++------ .../models/template_update_files_request.py | 12 ++++++------ .../models/template_update_files_response.py | 12 ++++++------ .../template_update_files_response_template.py | 12 ++++++------ .../unclaimed_draft_create_embedded_request.py | 12 ++++++------ ...ed_draft_create_embedded_with_template_request.py | 12 ++++++------ .../models/unclaimed_draft_create_request.py | 12 ++++++------ .../models/unclaimed_draft_create_response.py | 12 ++++++------ .../unclaimed_draft_edit_and_resend_request.py | 12 ++++++------ .../dropbox_sign/models/unclaimed_draft_response.py | 12 ++++++------ sdks/python/dropbox_sign/models/warning_response.py | 12 ++++++------ sdks/python/dropbox_sign/rest.py | 12 ++++++------ 206 files changed, 1236 insertions(+), 1236 deletions(-) diff --git a/sdks/python/dropbox_sign/__init__.py b/sdks/python/dropbox_sign/__init__.py index 2192ae233..53deb8f21 100644 --- a/sdks/python/dropbox_sign/__init__.py +++ b/sdks/python/dropbox_sign/__init__.py @@ -3,15 +3,15 @@ # flake8: noqa """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/api/account_api.py b/sdks/python/dropbox_sign/api/account_api.py index b3e5ce952..e3ba0b042 100644 --- a/sdks/python/dropbox_sign/api/account_api.py +++ b/sdks/python/dropbox_sign/api/account_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/api_app_api.py b/sdks/python/dropbox_sign/api/api_app_api.py index 93752b164..b130ad383 100644 --- a/sdks/python/dropbox_sign/api/api_app_api.py +++ b/sdks/python/dropbox_sign/api/api_app_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/bulk_send_job_api.py b/sdks/python/dropbox_sign/api/bulk_send_job_api.py index e53401b86..71ee4ca1f 100644 --- a/sdks/python/dropbox_sign/api/bulk_send_job_api.py +++ b/sdks/python/dropbox_sign/api/bulk_send_job_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/embedded_api.py b/sdks/python/dropbox_sign/api/embedded_api.py index fcb839f34..240da1b8e 100644 --- a/sdks/python/dropbox_sign/api/embedded_api.py +++ b/sdks/python/dropbox_sign/api/embedded_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/fax_api.py b/sdks/python/dropbox_sign/api/fax_api.py index 1d198e3a0..4cf485a75 100644 --- a/sdks/python/dropbox_sign/api/fax_api.py +++ b/sdks/python/dropbox_sign/api/fax_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/fax_line_api.py b/sdks/python/dropbox_sign/api/fax_line_api.py index 24b10831b..b2949be41 100644 --- a/sdks/python/dropbox_sign/api/fax_line_api.py +++ b/sdks/python/dropbox_sign/api/fax_line_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/o_auth_api.py b/sdks/python/dropbox_sign/api/o_auth_api.py index bedd1bfff..774f2049c 100644 --- a/sdks/python/dropbox_sign/api/o_auth_api.py +++ b/sdks/python/dropbox_sign/api/o_auth_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/report_api.py b/sdks/python/dropbox_sign/api/report_api.py index a31ee01f5..56314a1eb 100644 --- a/sdks/python/dropbox_sign/api/report_api.py +++ b/sdks/python/dropbox_sign/api/report_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/signature_request_api.py b/sdks/python/dropbox_sign/api/signature_request_api.py index f78d1a219..98f08aed8 100644 --- a/sdks/python/dropbox_sign/api/signature_request_api.py +++ b/sdks/python/dropbox_sign/api/signature_request_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/team_api.py b/sdks/python/dropbox_sign/api/team_api.py index 142d890c8..cd2c24468 100644 --- a/sdks/python/dropbox_sign/api/team_api.py +++ b/sdks/python/dropbox_sign/api/team_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/template_api.py b/sdks/python/dropbox_sign/api/template_api.py index 87be9f0fd..9ddb3130e 100644 --- a/sdks/python/dropbox_sign/api/template_api.py +++ b/sdks/python/dropbox_sign/api/template_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/unclaimed_draft_api.py b/sdks/python/dropbox_sign/api/unclaimed_draft_api.py index 620a71e90..75be55e4e 100644 --- a/sdks/python/dropbox_sign/api/unclaimed_draft_api.py +++ b/sdks/python/dropbox_sign/api/unclaimed_draft_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api_client.py b/sdks/python/dropbox_sign/api_client.py index 16e766078..1b2a6c711 100644 --- a/sdks/python/dropbox_sign/api_client.py +++ b/sdks/python/dropbox_sign/api_client.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/configuration.py b/sdks/python/dropbox_sign/configuration.py index 016c4e591..949829704 100644 --- a/sdks/python/dropbox_sign/configuration.py +++ b/sdks/python/dropbox_sign/configuration.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/exceptions.py b/sdks/python/dropbox_sign/exceptions.py index 43300ceac..d19f9220f 100644 --- a/sdks/python/dropbox_sign/exceptions.py +++ b/sdks/python/dropbox_sign/exceptions.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 from typing import Any, Optional diff --git a/sdks/python/dropbox_sign/models/__init__.py b/sdks/python/dropbox_sign/models/__init__.py index 97af4020e..71b8e6f5b 100644 --- a/sdks/python/dropbox_sign/models/__init__.py +++ b/sdks/python/dropbox_sign/models/__init__.py @@ -2,15 +2,15 @@ # flake8: noqa """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_create_request.py b/sdks/python/dropbox_sign/models/account_create_request.py index eb0d37416..62282b274 100644 --- a/sdks/python/dropbox_sign/models/account_create_request.py +++ b/sdks/python/dropbox_sign/models/account_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_create_response.py b/sdks/python/dropbox_sign/models/account_create_response.py index c1788e0e7..b8ff5aed3 100644 --- a/sdks/python/dropbox_sign/models/account_create_response.py +++ b/sdks/python/dropbox_sign/models/account_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_get_response.py b/sdks/python/dropbox_sign/models/account_get_response.py index 1be99f48c..f40a2d677 100644 --- a/sdks/python/dropbox_sign/models/account_get_response.py +++ b/sdks/python/dropbox_sign/models/account_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_response.py b/sdks/python/dropbox_sign/models/account_response.py index 8af0a6fb5..bf6e202fb 100644 --- a/sdks/python/dropbox_sign/models/account_response.py +++ b/sdks/python/dropbox_sign/models/account_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_response_quotas.py b/sdks/python/dropbox_sign/models/account_response_quotas.py index a58444549..8c69e6bab 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_response_usage.py b/sdks/python/dropbox_sign/models/account_response_usage.py index 8efc7a64b..6065a2230 100644 --- a/sdks/python/dropbox_sign/models/account_response_usage.py +++ b/sdks/python/dropbox_sign/models/account_response_usage.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_update_request.py b/sdks/python/dropbox_sign/models/account_update_request.py index 7b5c95ddf..5e0f577ec 100644 --- a/sdks/python/dropbox_sign/models/account_update_request.py +++ b/sdks/python/dropbox_sign/models/account_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_verify_request.py b/sdks/python/dropbox_sign/models/account_verify_request.py index a3a95c352..77e307efe 100644 --- a/sdks/python/dropbox_sign/models/account_verify_request.py +++ b/sdks/python/dropbox_sign/models/account_verify_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_verify_response.py b/sdks/python/dropbox_sign/models/account_verify_response.py index c5f1960be..1fc490f81 100644 --- a/sdks/python/dropbox_sign/models/account_verify_response.py +++ b/sdks/python/dropbox_sign/models/account_verify_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_verify_response_account.py b/sdks/python/dropbox_sign/models/account_verify_response_account.py index 3724cd063..715d9cea0 100644 --- a/sdks/python/dropbox_sign/models/account_verify_response_account.py +++ b/sdks/python/dropbox_sign/models/account_verify_response_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_create_request.py b/sdks/python/dropbox_sign/models/api_app_create_request.py index 4f7181b59..14af7b247 100644 --- a/sdks/python/dropbox_sign/models/api_app_create_request.py +++ b/sdks/python/dropbox_sign/models/api_app_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_get_response.py b/sdks/python/dropbox_sign/models/api_app_get_response.py index 5c03394e6..d9fe3f3f1 100644 --- a/sdks/python/dropbox_sign/models/api_app_get_response.py +++ b/sdks/python/dropbox_sign/models/api_app_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_list_response.py b/sdks/python/dropbox_sign/models/api_app_list_response.py index 748cc9365..f0272df9f 100644 --- a/sdks/python/dropbox_sign/models/api_app_list_response.py +++ b/sdks/python/dropbox_sign/models/api_app_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response.py b/sdks/python/dropbox_sign/models/api_app_response.py index a1f0bf157..42f1f87fd 100644 --- a/sdks/python/dropbox_sign/models/api_app_response.py +++ b/sdks/python/dropbox_sign/models/api_app_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py index 981f94d9f..eeeae66cf 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py +++ b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_options.py b/sdks/python/dropbox_sign/models/api_app_response_options.py index 751daf0de..cf3ef4f42 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py index c1ed456c8..7191f948a 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py +++ b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py index 734022f90..18d77df90 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_update_request.py b/sdks/python/dropbox_sign/models/api_app_update_request.py index e3f2a1abc..c393ba062 100644 --- a/sdks/python/dropbox_sign/models/api_app_update_request.py +++ b/sdks/python/dropbox_sign/models/api_app_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py index 749ba54b1..ed8fbfcc0 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py index de4b9a20a..e49e0a733 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py index 91d471ccc..5ec2b8c0d 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_response.py index 0812cb85d..75a8477e2 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py index e340ab831..60f57d13f 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py index 525dfa828..e727d14cf 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_response.py b/sdks/python/dropbox_sign/models/embedded_edit_url_response.py index 6c8ecc37a..c35ee6362 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_response.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py b/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py index 3dfe4d2d2..be2f6d26c 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_sign_url_response.py b/sdks/python/dropbox_sign/models/embedded_sign_url_response.py index ca92cdc23..6bc86e865 100644 --- a/sdks/python/dropbox_sign/models/embedded_sign_url_response.py +++ b/sdks/python/dropbox_sign/models/embedded_sign_url_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py b/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py index 6de5a5b8e..4777554c1 100644 --- a/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py +++ b/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/error_response.py b/sdks/python/dropbox_sign/models/error_response.py index f85c24767..64ee3a32c 100644 --- a/sdks/python/dropbox_sign/models/error_response.py +++ b/sdks/python/dropbox_sign/models/error_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/error_response_error.py b/sdks/python/dropbox_sign/models/error_response_error.py index 6577b27e7..244177c4d 100644 --- a/sdks/python/dropbox_sign/models/error_response_error.py +++ b/sdks/python/dropbox_sign/models/error_response_error.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/event_callback_request.py b/sdks/python/dropbox_sign/models/event_callback_request.py index 768983736..84b205a31 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request.py +++ b/sdks/python/dropbox_sign/models/event_callback_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event.py b/sdks/python/dropbox_sign/models/event_callback_request_event.py index 971fff98b..470f382fd 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py b/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py index 572abb509..c9ca17c7e 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_get_response.py b/sdks/python/dropbox_sign/models/fax_get_response.py index 8c2b2249f..15b1788bf 100644 --- a/sdks/python/dropbox_sign/models/fax_get_response.py +++ b/sdks/python/dropbox_sign/models/fax_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py index 10419081a..59ba5dbe9 100644 --- a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py index 62b87eb08..94df88562 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py index cbe1eea81..e7994f3f5 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py index ac8722d39..c0d098bfc 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py index 51f9da013..8cfe5ad2e 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_create_request.py b/sdks/python/dropbox_sign/models/fax_line_create_request.py index fddd8acf3..3548180dc 100644 --- a/sdks/python/dropbox_sign/models/fax_line_create_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_delete_request.py b/sdks/python/dropbox_sign/models/fax_line_delete_request.py index 265607f78..b65b06f17 100644 --- a/sdks/python/dropbox_sign/models/fax_line_delete_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_delete_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_list_response.py b/sdks/python/dropbox_sign/models/fax_line_list_response.py index 099c3cc55..d646b66e8 100644 --- a/sdks/python/dropbox_sign/models/fax_line_list_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py index d75613bef..371178063 100644 --- a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_response.py b/sdks/python/dropbox_sign/models/fax_line_response.py index a719bc9fa..4a4cd3578 100644 --- a/sdks/python/dropbox_sign/models/fax_line_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py index 7d89f44cc..9ebd7db5b 100644 --- a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py +++ b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_list_response.py b/sdks/python/dropbox_sign/models/fax_list_response.py index b62b406e1..97dd078e7 100644 --- a/sdks/python/dropbox_sign/models/fax_list_response.py +++ b/sdks/python/dropbox_sign/models/fax_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_response.py b/sdks/python/dropbox_sign/models/fax_response.py index 976606e37..9a5ffce3d 100644 --- a/sdks/python/dropbox_sign/models/fax_response.py +++ b/sdks/python/dropbox_sign/models/fax_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_response_transmission.py b/sdks/python/dropbox_sign/models/fax_response_transmission.py index 28cf397a0..1b1dc6e87 100644 --- a/sdks/python/dropbox_sign/models/fax_response_transmission.py +++ b/sdks/python/dropbox_sign/models/fax_response_transmission.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_send_request.py b/sdks/python/dropbox_sign/models/fax_send_request.py index a8b3b3c1d..4b6428230 100644 --- a/sdks/python/dropbox_sign/models/fax_send_request.py +++ b/sdks/python/dropbox_sign/models/fax_send_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/file_response.py b/sdks/python/dropbox_sign/models/file_response.py index e0479e3d6..e08fe26b4 100644 --- a/sdks/python/dropbox_sign/models/file_response.py +++ b/sdks/python/dropbox_sign/models/file_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/file_response_data_uri.py b/sdks/python/dropbox_sign/models/file_response_data_uri.py index c7c2e403f..94613587d 100644 --- a/sdks/python/dropbox_sign/models/file_response_data_uri.py +++ b/sdks/python/dropbox_sign/models/file_response_data_uri.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/list_info_response.py b/sdks/python/dropbox_sign/models/list_info_response.py index b51627288..1f6cf2ad8 100644 --- a/sdks/python/dropbox_sign/models/list_info_response.py +++ b/sdks/python/dropbox_sign/models/list_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py b/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py index ff2aefb6b..7f17c50f5 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py b/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py index 573036386..02400c6a9 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_response.py b/sdks/python/dropbox_sign/models/o_auth_token_response.py index e42732a19..d9a1569c3 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_response.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/report_create_request.py b/sdks/python/dropbox_sign/models/report_create_request.py index 4bed0f940..d142b6d5b 100644 --- a/sdks/python/dropbox_sign/models/report_create_request.py +++ b/sdks/python/dropbox_sign/models/report_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/report_create_response.py b/sdks/python/dropbox_sign/models/report_create_response.py index 6fc7ec8e0..7143a93ea 100644 --- a/sdks/python/dropbox_sign/models/report_create_response.py +++ b/sdks/python/dropbox_sign/models/report_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/report_response.py b/sdks/python/dropbox_sign/models/report_response.py index 2ed765c4a..7a41b74fd 100644 --- a/sdks/python/dropbox_sign/models/report_response.py +++ b/sdks/python/dropbox_sign/models/report_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py index a3250eb3c..23c253846 100644 --- a/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py index 6c122576b..c6b2b7032 100644 --- a/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py index 8912b4560..8733c885a 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py index 2c7d080d7..8bec42df4 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_get_response.py b/sdks/python/dropbox_sign/models/signature_request_get_response.py index 8a1c556f4..444d5beda 100644 --- a/sdks/python/dropbox_sign/models/signature_request_get_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_list_response.py b/sdks/python/dropbox_sign/models/signature_request_list_response.py index 02f8d7426..e5a08fdfa 100644 --- a/sdks/python/dropbox_sign/models/signature_request_list_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_remind_request.py b/sdks/python/dropbox_sign/models/signature_request_remind_request.py index 21483ce2a..32c150011 100644 --- a/sdks/python/dropbox_sign/models/signature_request_remind_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_remind_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response.py b/sdks/python/dropbox_sign/models/signature_request_response.py index e367012a3..a79c0aad1 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_attachment.py b/sdks/python/dropbox_sign/models/signature_request_response_attachment.py index a8f364ba7..5c5648510 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_attachment.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_attachment.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py index 03fd81e16..fd5117bd9 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py index 229a9f245..22f87e272 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py index b4605b54f..e6ea56624 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py index db67d6872..8f715aea2 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_base.py b/sdks/python/dropbox_sign/models/signature_request_response_data_base.py index 1e72f17e7..3999601fe 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_base.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py b/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py index edd8ac007..8c4d01dac 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py index 97dd0ebf9..5810aff16 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py index a48b3d07e..11c3618dc 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py index b06f89be6..9c9ae9cc5 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py index 94ea1c7f4..cdd8d423e 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py index f5a493c75..f3eae53bd 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py index 8b531ece2..cebf21665 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py index 86461b32a..349299559 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py index df76cb604..7fa2c6e71 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py index 15ffbb331..f32e60fec 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_signatures.py b/sdks/python/dropbox_sign/models/signature_request_response_signatures.py index 0a964e5f8..70a26b495 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_signatures.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_signatures.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_send_request.py b/sdks/python/dropbox_sign/models/signature_request_send_request.py index 806a1def1..3618ed1c1 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py index 9c4045a3e..53c7efe26 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_update_request.py b/sdks/python/dropbox_sign/models/signature_request_update_request.py index 37c4e18b2..c0c45afb5 100644 --- a/sdks/python/dropbox_sign/models/signature_request_update_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_attachment.py b/sdks/python/dropbox_sign/models/sub_attachment.py index a0c288d3a..65aa53c45 100644 --- a/sdks/python/dropbox_sign/models/sub_attachment.py +++ b/sdks/python/dropbox_sign/models/sub_attachment.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py b/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py index d5d8edb45..e647cd8c1 100644 --- a/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py +++ b/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py b/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py index dbd925d79..aef9b0ed2 100644 --- a/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py +++ b/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_cc.py b/sdks/python/dropbox_sign/models/sub_cc.py index a0aa82906..5ea92108c 100644 --- a/sdks/python/dropbox_sign/models/sub_cc.py +++ b/sdks/python/dropbox_sign/models/sub_cc.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_custom_field.py b/sdks/python/dropbox_sign/models/sub_custom_field.py index aa837bcdc..3fe2bf546 100644 --- a/sdks/python/dropbox_sign/models/sub_custom_field.py +++ b/sdks/python/dropbox_sign/models/sub_custom_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_editor_options.py b/sdks/python/dropbox_sign/models/sub_editor_options.py index 7e4315cbe..f67cfcbbd 100644 --- a/sdks/python/dropbox_sign/models/sub_editor_options.py +++ b/sdks/python/dropbox_sign/models/sub_editor_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_field_options.py b/sdks/python/dropbox_sign/models/sub_field_options.py index bd4ca3aa1..95c6514f1 100644 --- a/sdks/python/dropbox_sign/models/sub_field_options.py +++ b/sdks/python/dropbox_sign/models/sub_field_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_group.py b/sdks/python/dropbox_sign/models/sub_form_field_group.py index 9a9964b90..51a96961f 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_group.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_group.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule.py b/sdks/python/dropbox_sign/models/sub_form_field_rule.py index 345122638..2ca3d4e11 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py b/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py index 2e8eedfae..0f5c2e2a2 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py b/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py index 124a9212c..03b534175 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py index 0f05fbeee..1d9a0dd51 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py index f1765d128..9a93b890f 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py index 157a66f5c..dc16dd79b 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py index 298b43a5a..17e0b8a69 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py index 331b61720..dfab88a88 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py index 5244ac297..8865fdc9e 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py index f8c9d0c54..c9fda0dc0 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py index 8962b4cee..a5d640cba 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py index 69407f506..b34e05863 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py index e900a7500..3c7a3cf18 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py index b7f473dd3..ff7c01f0d 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py index 318deab88..77ee57590 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py index e2ca1330f..e1d61ca05 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_merge_field.py b/sdks/python/dropbox_sign/models/sub_merge_field.py index dba544e80..1db7477c9 100644 --- a/sdks/python/dropbox_sign/models/sub_merge_field.py +++ b/sdks/python/dropbox_sign/models/sub_merge_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_o_auth.py b/sdks/python/dropbox_sign/models/sub_o_auth.py index 979d595aa..b0ec45aca 100644 --- a/sdks/python/dropbox_sign/models/sub_o_auth.py +++ b/sdks/python/dropbox_sign/models/sub_o_auth.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_options.py b/sdks/python/dropbox_sign/models/sub_options.py index bd4f00ae8..20d318b8b 100644 --- a/sdks/python/dropbox_sign/models/sub_options.py +++ b/sdks/python/dropbox_sign/models/sub_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py b/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py index 24671c921..5b4fbac5c 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_signer.py b/sdks/python/dropbox_sign/models/sub_signature_request_signer.py index ac567d564..495d43b21 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_signer.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py b/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py index 44b6881d8..a0dbbb9b6 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signing_options.py b/sdks/python/dropbox_sign/models/sub_signing_options.py index e6cd96000..1b5ebebc8 100644 --- a/sdks/python/dropbox_sign/models/sub_signing_options.py +++ b/sdks/python/dropbox_sign/models/sub_signing_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_team_response.py b/sdks/python/dropbox_sign/models/sub_team_response.py index 98e55e192..7477a0164 100644 --- a/sdks/python/dropbox_sign/models/sub_team_response.py +++ b/sdks/python/dropbox_sign/models/sub_team_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_template_role.py b/sdks/python/dropbox_sign/models/sub_template_role.py index 187fa77f9..82c52f920 100644 --- a/sdks/python/dropbox_sign/models/sub_template_role.py +++ b/sdks/python/dropbox_sign/models/sub_template_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py index fcc70e385..e6eac58fb 100644 --- a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py +++ b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py index 2154537e8..60a5c21b1 100644 --- a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py +++ b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py index 218da2aea..5c85661d0 100644 --- a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_add_member_request.py b/sdks/python/dropbox_sign/models/team_add_member_request.py index 275ccf00f..08491820e 100644 --- a/sdks/python/dropbox_sign/models/team_add_member_request.py +++ b/sdks/python/dropbox_sign/models/team_add_member_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_create_request.py b/sdks/python/dropbox_sign/models/team_create_request.py index 0c0c696ad..bf97f938c 100644 --- a/sdks/python/dropbox_sign/models/team_create_request.py +++ b/sdks/python/dropbox_sign/models/team_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_get_info_response.py b/sdks/python/dropbox_sign/models/team_get_info_response.py index 3453baa20..e9d858a54 100644 --- a/sdks/python/dropbox_sign/models/team_get_info_response.py +++ b/sdks/python/dropbox_sign/models/team_get_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_get_response.py b/sdks/python/dropbox_sign/models/team_get_response.py index 65845b263..c6a4a122a 100644 --- a/sdks/python/dropbox_sign/models/team_get_response.py +++ b/sdks/python/dropbox_sign/models/team_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_info_response.py b/sdks/python/dropbox_sign/models/team_info_response.py index 4c6ae507f..233239b41 100644 --- a/sdks/python/dropbox_sign/models/team_info_response.py +++ b/sdks/python/dropbox_sign/models/team_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_invite_response.py b/sdks/python/dropbox_sign/models/team_invite_response.py index fbc7d130a..28dcae72e 100644 --- a/sdks/python/dropbox_sign/models/team_invite_response.py +++ b/sdks/python/dropbox_sign/models/team_invite_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_invites_response.py b/sdks/python/dropbox_sign/models/team_invites_response.py index aa448daff..a664ef227 100644 --- a/sdks/python/dropbox_sign/models/team_invites_response.py +++ b/sdks/python/dropbox_sign/models/team_invites_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_member_response.py b/sdks/python/dropbox_sign/models/team_member_response.py index 0930eaa85..467363a90 100644 --- a/sdks/python/dropbox_sign/models/team_member_response.py +++ b/sdks/python/dropbox_sign/models/team_member_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_members_response.py b/sdks/python/dropbox_sign/models/team_members_response.py index f150d6ef4..5ef8f105d 100644 --- a/sdks/python/dropbox_sign/models/team_members_response.py +++ b/sdks/python/dropbox_sign/models/team_members_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_parent_response.py b/sdks/python/dropbox_sign/models/team_parent_response.py index 633b10b61..14e9b971f 100644 --- a/sdks/python/dropbox_sign/models/team_parent_response.py +++ b/sdks/python/dropbox_sign/models/team_parent_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_remove_member_request.py b/sdks/python/dropbox_sign/models/team_remove_member_request.py index d21215dca..e4266772f 100644 --- a/sdks/python/dropbox_sign/models/team_remove_member_request.py +++ b/sdks/python/dropbox_sign/models/team_remove_member_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_response.py b/sdks/python/dropbox_sign/models/team_response.py index 57bec3332..a1364ddd1 100644 --- a/sdks/python/dropbox_sign/models/team_response.py +++ b/sdks/python/dropbox_sign/models/team_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_sub_teams_response.py b/sdks/python/dropbox_sign/models/team_sub_teams_response.py index 6d6b76c23..97c1fd5c1 100644 --- a/sdks/python/dropbox_sign/models/team_sub_teams_response.py +++ b/sdks/python/dropbox_sign/models/team_sub_teams_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_update_request.py b/sdks/python/dropbox_sign/models/team_update_request.py index e7bdb4307..4eef699dc 100644 --- a/sdks/python/dropbox_sign/models/team_update_request.py +++ b/sdks/python/dropbox_sign/models/team_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_add_user_request.py b/sdks/python/dropbox_sign/models/template_add_user_request.py index 34c4ed62d..a842890f4 100644 --- a/sdks/python/dropbox_sign/models/template_add_user_request.py +++ b/sdks/python/dropbox_sign/models/template_add_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py index 983d872f7..de35b19eb 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py index 5e728e79d..d27401f86 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py index be23c205a..604fbf0ef 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_request.py b/sdks/python/dropbox_sign/models/template_create_request.py index fa6df563c..0f453b4b9 100644 --- a/sdks/python/dropbox_sign/models/template_create_request.py +++ b/sdks/python/dropbox_sign/models/template_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_response.py b/sdks/python/dropbox_sign/models/template_create_response.py index a42054f3c..02102b69b 100644 --- a/sdks/python/dropbox_sign/models/template_create_response.py +++ b/sdks/python/dropbox_sign/models/template_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_response_template.py b/sdks/python/dropbox_sign/models/template_create_response_template.py index e4f253ef0..281a196f8 100644 --- a/sdks/python/dropbox_sign/models/template_create_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_edit_response.py b/sdks/python/dropbox_sign/models/template_edit_response.py index 05b99f4c3..cf1542494 100644 --- a/sdks/python/dropbox_sign/models/template_edit_response.py +++ b/sdks/python/dropbox_sign/models/template_edit_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_get_response.py b/sdks/python/dropbox_sign/models/template_get_response.py index a32292b4f..c9976881b 100644 --- a/sdks/python/dropbox_sign/models/template_get_response.py +++ b/sdks/python/dropbox_sign/models/template_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_list_response.py b/sdks/python/dropbox_sign/models/template_list_response.py index 5deebe214..a7c4f7c7d 100644 --- a/sdks/python/dropbox_sign/models/template_list_response.py +++ b/sdks/python/dropbox_sign/models/template_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_remove_user_request.py b/sdks/python/dropbox_sign/models/template_remove_user_request.py index 565c47e32..7c1eb4d8c 100644 --- a/sdks/python/dropbox_sign/models/template_remove_user_request.py +++ b/sdks/python/dropbox_sign/models/template_remove_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index 01f36b353..88bdb041e 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_account.py b/sdks/python/dropbox_sign/models/template_response_account.py index 71358ff84..09ddc2130 100644 --- a/sdks/python/dropbox_sign/models/template_response_account.py +++ b/sdks/python/dropbox_sign/models/template_response_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_account_quota.py b/sdks/python/dropbox_sign/models/template_response_account_quota.py index 6c03effe9..bcccd2d25 100644 --- a/sdks/python/dropbox_sign/models/template_response_account_quota.py +++ b/sdks/python/dropbox_sign/models/template_response_account_quota.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_cc_role.py b/sdks/python/dropbox_sign/models/template_response_cc_role.py index 8c005227d..88cd630eb 100644 --- a/sdks/python/dropbox_sign/models/template_response_cc_role.py +++ b/sdks/python/dropbox_sign/models/template_response_cc_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document.py b/sdks/python/dropbox_sign/models/template_response_document.py index 56e887bd0..27f7c9b7b 100644 --- a/sdks/python/dropbox_sign/models/template_response_document.py +++ b/sdks/python/dropbox_sign/models/template_response_document.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py index a7d2fa60c..7a9e276ff 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py index 4edf644c2..62d20d94f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py index 760dd57a4..489a15d0c 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group.py b/sdks/python/dropbox_sign/models/template_response_document_field_group.py index 201bd139e..e8492546d 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py index e5ade9d4e..9409fac83 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py index 62f6d5f5b..210bf9f3f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py index 29c4ff1e8..5e6c23b99 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py index 9b466fa1c..60469a645 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py index 65b253c5d..de5c1eb0a 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py index 90f0c1f25..5f0ad6384 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py index bc8512b4f..03003ab26 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py index 7e76f9e27..aa9126b61 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py index 7e742cebe..166fe3330 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py index c04d1b550..66322b76f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py index 4c16302d2..8c6e26f01 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py index ea1c2b787..2ebc79440 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py index 3a9bf86e0..fe923c931 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py index 8444e77d8..db70fb277 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py index 43106f1b1..3618481e3 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py index 884425354..9c4534c48 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py index e0701f1cc..3d85ef946 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py index dbd12110f..8e27c3c54 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py index 7fe3d5925..26e309e90 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py index b3b5d4aff..552b7a87e 100644 --- a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py +++ b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_signer_role.py b/sdks/python/dropbox_sign/models/template_response_signer_role.py index aab8250c4..8f013c4a8 100644 --- a/sdks/python/dropbox_sign/models/template_response_signer_role.py +++ b/sdks/python/dropbox_sign/models/template_response_signer_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_update_files_request.py b/sdks/python/dropbox_sign/models/template_update_files_request.py index e8d3f22cd..9aed90b10 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_request.py +++ b/sdks/python/dropbox_sign/models/template_update_files_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_update_files_response.py b/sdks/python/dropbox_sign/models/template_update_files_response.py index d2c07763a..d8a4728dc 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_update_files_response_template.py b/sdks/python/dropbox_sign/models/template_update_files_response_template.py index a8fb50fa3..ba5a06762 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response_template.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py index 33b165023..353355121 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py index a09307d19..798121996 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py index 2833e239b..207649f9c 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py index 11ae0d902..334c47d70 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py index 4b84d1031..5461f8702 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_response.py b/sdks/python/dropbox_sign/models/unclaimed_draft_response.py index 1cd950950..1678b95ea 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_response.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/warning_response.py b/sdks/python/dropbox_sign/models/warning_response.py index f5aa1277d..67a037a1b 100644 --- a/sdks/python/dropbox_sign/models/warning_response.py +++ b/sdks/python/dropbox_sign/models/warning_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/rest.py b/sdks/python/dropbox_sign/rest.py index b369c3fde..877df1cd8 100644 --- a/sdks/python/dropbox_sign/rest.py +++ b/sdks/python/dropbox_sign/rest.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501